@itentialopensource/adapter-alkira

{ "openapi": "3.1.0", "info": { "title": "", "version": "1.0.0" }, "paths": { "/users/login": { "post": { "tags": [ "Authentication" ], "operationId": "loginUsersUsingPOST", "description": "The parameters and request body are for method: loginUsersUsingPOST. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/users/logout": { "post": { "tags": [ "Authentication" ], "operationId": "logoutUsersUsingPOST", "description": "The parameters and request body are for method: logoutUsersUsingPOST. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/login": { "post": { "tags": [ "Authentication" ], "operationId": "postLogin", "description": "The parameters and request body are for method: postLogin. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/oauth/login": { "post": { "tags": [ "Authentication" ], "operationId": "oauthLogin", "description": "The parameters and request body are for method: oauthLogin. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/logout": { "get": { "tags": [ "Authentication" ], "operationId": "getLogout", "description": "The parameters and request body are for method: getLogout. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/sessions": { "post": { "tags": [ "Authentication" ], "operationId": "createSession", "description": "The parameters and request body are for method: createSession. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "Authentication" ], "operationId": "deleteSession", "description": "The parameters and request body are for method: deleteSession. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/otp/login": { "post": { "tags": [ "Authentication" ], "operationId": "otpLogin", "description": "The parameters and request body are for method: otpLogin. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "otp", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/tenantnetworks/{tenantNetworkId}/segments": { "get": { "tags": [ "Segments" ], "operationId": "getsegments", "description": "The parameters and request body are for method: getsegments. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "tenantId": { "type": "number" }, "tenantNetworkId": { "type": "number" }, "internalName": { "type": "string" }, "ipBlock": { "type": "string" }, "ipBlocks": { "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string" } }, "percentageIPBlocksUsed": { "type": "number" } } }, "name": { "type": "string" }, "segmentNo": { "type": "number" }, "services": { "type": "array", "items": { "type": "number" } }, "connectors": { "type": "array", "items": { "type": "number" } }, "asn": { "type": "number" }, "state": { "type": "object" }, "enterpriseDNSServerIP": { "type": "string" }, "reservePublicIPsForUserAndSiteConnectivity": { "type": "boolean" }, "reservedPublicIPsForUserAndSiteConnectivity": { "type": "object", "properties": { "US-WEST": { "type": "array", "items": { "type": "string" } }, "US-EAST": { "type": "array", "items": { "type": "string" } } } }, "enableIpv6ToIpv4Translation": { "type": "boolean" }, "srcIpv4PoolList": { "type": "array", "items": { "type": "object", "properties": { "startIp": { "type": "string" }, "endIp": { "type": "string" } } } }, "lastConfigUpdatedAt": { "type": "number" } } } }, "example": [ { "id": 112, "tenantId": 2, "tenantNetworkId": 2, "internalName": "rock-0000001-01", "ipBlock": "10.255.254.0/24", "ipBlocks": { "values": [ "10.255.254.0/24", "192.168.1.0/24" ], "percentageIPBlocksUsed": 0.45 }, "name": "rock", "segmentNo": 1, "services": [ 1, 2, 3, 4 ], "connectors": [ 1, 2, 3, 4 ], "asn": 65002, "state": {}, "enterpriseDNSServerIP": "8.8.8.8", "reservePublicIPsForUserAndSiteConnectivity": true, "reservedPublicIPsForUserAndSiteConnectivity": { "US-WEST": [ "172.168.1.1", "172.168.1.2" ], "US-EAST": [ "174.168.1.1", "174.168.1.2" ] }, "enableIpv6ToIpv4Translation": true, "srcIpv4PoolList": [ { "startIp": "10.2.1.0", "endIp": "10.2.2.0" }, { "startIp": "10.2.1.0", "endIp": "10.2.2.0" }, { "startIp": "10.2.1.0", "endIp": "10.2.2.0" }, { "startIp": "10.2.1.0", "endIp": "10.2.2.0" }, { "startIp": "10.2.1.0", "endIp": "10.2.2.0" }, { "startIp": "10.2.1.0", "endIp": "10.2.2.0" }, { "startIp": "10.2.1.0", "endIp": "10.2.2.0" }, { "startIp": "10.2.1.0", "endIp": "10.2.2.0" } ], "lastConfigUpdatedAt": 16415804051010 }, { "id": 112, "tenantId": 2, "tenantNetworkId": 2, "internalName": "rock-0000001-01", "ipBlock": "10.255.254.0/24", "ipBlocks": { "values": [ "10.255.254.0/24", "192.168.1.0/24" ], "percentageIPBlocksUsed": 0.45 }, "name": "rock", "segmentNo": 1, "services": [ 1, 2, 3, 4 ], "connectors": [ 1, 2, 3, 4 ], "asn": 65002, "state": {}, "enterpriseDNSServerIP": "8.8.8.8", "reservePublicIPsForUserAndSiteConnectivity": true, "reservedPublicIPsForUserAndSiteConnectivity": { "US-WEST": [ "172.168.1.1", "172.168.1.2" ], "US-EAST": [ "174.168.1.1", "174.168.1.2" ] }, "enableIpv6ToIpv4Translation": true, "srcIpv4PoolList": [ { "startIp": "10.2.1.0", "endIp": "10.2.2.0" }, { "startIp": "10.2.1.0", "endIp": "10.2.2.0" }, { "startIp": "10.2.1.0", "endIp": "10.2.2.0" }, { "startIp": "10.2.1.0", "endIp": "10.2.2.0" } ], "lastConfigUpdatedAt": 16415804051010 }, { "id": 112, "tenantId": 2, "tenantNetworkId": 2, "internalName": "rock-0000001-01", "ipBlock": "10.255.254.0/24", "ipBlocks": { "values": [ "10.255.254.0/24", "192.168.1.0/24" ], "percentageIPBlocksUsed": 0.45 }, "name": "rock", "segmentNo": 1, "services": [ 1, 2, 3, 4 ], "connectors": [ 1, 2, 3, 4 ], "asn": 65002, "state": {}, "enterpriseDNSServerIP": "8.8.8.8", "reservePublicIPsForUserAndSiteConnectivity": true, "reservedPublicIPsForUserAndSiteConnectivity": { "US-WEST": [ "172.168.1.1", "172.168.1.2" ], "US-EAST": [ "174.168.1.1", "174.168.1.2" ] }, "enableIpv6ToIpv4Translation": true, "srcIpv4PoolList": [ { "startIp": "10.2.1.0", "endIp": "10.2.2.0" }, { "startIp": "10.2.1.0", "endIp": "10.2.2.0" } ], "lastConfigUpdatedAt": 16415804051010 } ] } } } }, "parameters": [ { "name": "tenantNetworkId", "in": "path", "required": true, "schema": { "title": "tenantNetworkId", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Segments" ], "operationId": "createSegment", "description": "The parameters and request body are for method: createSegment. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "tenantNetworkId", "in": "path", "required": true, "schema": { "title": "tenantNetworkId", "type": "number" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/tenantnetworks/{tenantNetworkId}/segments/{segmentId}": { "get": { "tags": [ "Segments" ], "operationId": "getSegment", "description": "The parameters and request body are for method: getSegment. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "tenantNetworkId", "in": "path", "required": true, "schema": { "title": "tenantNetworkId", "type": "number" } }, { "name": "segmentId", "in": "path", "required": true, "schema": { "title": "segmentId", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "Segments" ], "operationId": "updateSegment", "description": "The parameters and request body are for method: updateSegment. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "tenantNetworkId", "in": "path", "required": true, "schema": { "title": "tenantNetworkId", "type": "number" } }, { "name": "segmentId", "in": "path", "required": true, "schema": { "title": "segmentId", "type": "number" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "Segments" ], "operationId": "deleteSegment", "description": "The parameters and request body are for method: deleteSegment. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "tenantNetworkId", "in": "path", "required": true, "schema": { "title": "tenantNetworkId", "type": "number" } }, { "name": "segmentId", "in": "path", "required": true, "schema": { "title": "segmentId", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/tenantnetworks/{tenantNetworkId}/groups": { "get": { "tags": [ "Groups" ], "operationId": "getgroups", "description": "The parameters and request body are for method: getgroups. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "tenantId": { "type": "number" }, "tenantNetworkId": { "type": "number" }, "description": { "type": "string" }, "encodedTags": { "type": "array", "items": { "type": "string" } }, "firewallZoneIds": { "type": "array", "items": { "type": "number" } }, "internalName": { "type": "string" }, "name": { "type": "string" }, "systemGenerated": { "type": "boolean" }, "tags": { "type": "array", "items": { "type": "number" } }, "type": { "type": "object" } } } }, "example": [ { "id": 2, "tenantId": 3, "tenantNetworkId": 2, "description": "string", "encodedTags": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "firewallZoneIds": [ 10, 8, 4, 7 ], "internalName": "string", "name": "string", "systemGenerated": false, "tags": [ 5 ], "type": null }, { "id": 5, "tenantId": 1, "tenantNetworkId": 8, "description": "string", "encodedTags": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "firewallZoneIds": [ 4, 1, 3, 9, 5, 6, 1, 3 ], "internalName": "string", "name": "string", "systemGenerated": false, "tags": [ 3, 1, 5, 8, 9, 10, 7, 6, 9 ], "type": null }, { "id": 8, "tenantId": 9, "tenantNetworkId": 8, "description": "string", "encodedTags": [ "string", "string", "string", "string", "string", "string" ], "firewallZoneIds": [ 9, 3, 9 ], "internalName": "string", "name": "string", "systemGenerated": true, "tags": [ 5, 8, 9, 7, 4, 8, 9, 7 ], "type": null } ] } } } }, "parameters": [ { "name": "tenantNetworkId", "in": "path", "required": true, "schema": { "title": "tenantNetworkId", "type": "number" } }, { "name": "segmentId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "serviceId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "groupTypes", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Groups" ], "operationId": "creategroups", "description": "The parameters and request body are for method: creategroups. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "tenantNetworkId", "in": "path", "required": true, "schema": { "title": "tenantNetworkId", "type": "number" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/tenantnetworks/{tenantNetworkId}/groups/{groupId}": { "get": { "tags": [ "Groups" ], "operationId": "getgroup", "description": "The parameters and request body are for method: getgroup. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "tenantNetworkId", "in": "path", "required": true, "schema": { "title": "tenantNetworkId", "type": "number" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "title": "groupId", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "Groups" ], "operationId": "updategroups", "description": "The parameters and request body are for method: updategroups. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "tenantNetworkId", "in": "path", "required": true, "schema": { "title": "tenantNetworkId", "type": "number" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "title": "groupId", "type": "number" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "Groups" ], "operationId": "deletegroups", "description": "The parameters and request body are for method: deletegroups. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "tenantNetworkId", "in": "path", "required": true, "schema": { "title": "tenantNetworkId", "type": "number" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "title": "groupId", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/users": { "get": { "tags": [ "Users" ], "operationId": "getAllUsersUsingGET", "description": "The parameters and request body are for method: getAllUsersUsingGET. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string" }, "firstName": { "type": "string" }, "id": { "type": "string" }, "idpId": { "type": "string" }, "lastLoggedIn": { "type": "number" }, "lastName": { "type": "string" }, "password": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } }, "tenantId": { "type": "string" }, "userName": { "type": "string" }, "userType": { "type": "object" }, "jwksUri": { "type": "string" }, "serviceProvider": { "type": "object" } } } }, "example": [ { "email": "john@abc.com", "firstName": "John", "id": "78772b5e-ed20-11ea-adc1-0242ac120777", "idpId": "78772b5e-ed20-11ea-adc1-0242ac120002", "lastLoggedIn": 8, "lastName": "Doe", "password": "string", "roles": [ "netadmin" ], "tenantId": "1", "userName": "john", "userType": null, "jwksUri": "https://www.alkira.com", "serviceProvider": null }, { "email": "john@abc.com", "firstName": "John", "id": "78772b5e-ed20-11ea-adc1-0242ac120777", "idpId": "78772b5e-ed20-11ea-adc1-0242ac120002", "lastLoggedIn": 1, "lastName": "Doe", "password": "string", "roles": [ "netadmin" ], "tenantId": "1", "userName": "john", "userType": null, "jwksUri": "https://www.alkira.com", "serviceProvider": null }, { "email": "john@abc.com", "firstName": "John", "id": "78772b5e-ed20-11ea-adc1-0242ac120777", "idpId": "78772b5e-ed20-11ea-adc1-0242ac120002", "lastLoggedIn": 5, "lastName": "Doe", "password": "string", "roles": [ "netadmin" ], "tenantId": "1", "userName": "john", "userType": null, "jwksUri": "https://www.alkira.com", "serviceProvider": null }, { "email": "john@abc.com", "firstName": "John", "id": "78772b5e-ed20-11ea-adc1-0242ac120777", "idpId": "78772b5e-ed20-11ea-adc1-0242ac120002", "lastLoggedIn": 1, "lastName": "Doe", "password": "string", "roles": [ "netadmin" ], "tenantId": "1", "userName": "john", "userType": null, "jwksUri": "https://www.alkira.com", "serviceProvider": null } ] } } } }, "parameters": [ { "name": "userName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "active", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Users" ], "operationId": "createUsersUsingPOST", "description": "The parameters and request body are for method: createUsersUsingPOST. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string" }, "firstName": { "type": "string" }, "id": { "type": "string" }, "idpId": { "type": "string" }, "lastLoggedIn": { "type": "number" }, "lastName": { "type": "string" }, "password": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } }, "tenantId": { "type": "string" }, "userName": { "type": "string" }, "userType": { "type": "object" }, "jwksUri": { "type": "string" }, "serviceProvider": { "type": "object" } } }, "example": { "email": "john@abc.com", "firstName": "John", "id": "78772b5e-ed20-11ea-adc1-0242ac120777", "idpId": "78772b5e-ed20-11ea-adc1-0242ac120002", "lastLoggedIn": 8, "lastName": "Doe", "password": "string", "roles": [ "netadmin" ], "tenantId": "1", "userName": "john", "userType": null, "jwksUri": "https://www.alkira.com", "serviceProvider": null } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/users/{userId}": { "get": { "tags": [ "Users" ], "operationId": "getUsersByIdUsingGET", "description": "The parameters and request body are for method: getUsersByIdUsingGET. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string" }, "firstName": { "type": "string" }, "id": { "type": "string" }, "idpId": { "type": "string" }, "lastLoggedIn": { "type": "number" }, "lastName": { "type": "string" }, "password": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } }, "tenantId": { "type": "string" }, "userName": { "type": "string" }, "userType": { "type": "object" }, "jwksUri": { "type": "string" }, "serviceProvider": { "type": "object" } } }, "example": { "email": "john@abc.com", "firstName": "John", "id": "78772b5e-ed20-11ea-adc1-0242ac120777", "idpId": "78772b5e-ed20-11ea-adc1-0242ac120002", "lastLoggedIn": 10, "lastName": "Doe", "password": "string", "roles": [ "netadmin" ], "tenantId": "1", "userName": "john", "userType": null, "jwksUri": "https://www.alkira.com", "serviceProvider": null } } } } }, "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "title": "userId", "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "Users" ], "operationId": "updateUsersByIdUsingPUT", "description": "The parameters and request body are for method: updateUsersByIdUsingPUT. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string" }, "firstName": { "type": "string" }, "id": { "type": "string" }, "idpId": { "type": "string" }, "lastLoggedIn": { "type": "number" }, "lastName": { "type": "string" }, "password": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } }, "tenantId": { "type": "string" }, "userName": { "type": "string" }, "userType": { "type": "object" }, "jwksUri": { "type": "string" }, "serviceProvider": { "type": "object" } } }, "example": { "email": "john@abc.com", "firstName": "John", "id": "78772b5e-ed20-11ea-adc1-0242ac120777", "idpId": "78772b5e-ed20-11ea-adc1-0242ac120002", "lastLoggedIn": 6, "lastName": "Doe", "password": "string", "roles": [ "netadmin" ], "tenantId": "1", "userName": "john", "userType": null, "jwksUri": "https://www.alkira.com", "serviceProvider": null } } } } }, "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "title": "userId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "Users" ], "operationId": "deleteUsersByIdUs