@itentialopensource/adapter-alkira

{ "openapi": "3.0.0", "info": { "title": "Alkira API", "contact": { "name": "Alkira API", "email": "api@alkira.com" }, "version": "v1" }, "servers": [ { "url": "https://{domain}.alkira2.net/api", "variables": { "domain": { "default": "domainDefaultValue" } } } ], "paths": { "/users/login": { "post": { "tags": [ "Authentication" ], "summary": "loginUsersUsingPOST", "description": "Login a User", "operationId": "loginUsersUsingPOST", "parameters": [], "requestBody": { "description": "credentials", "content": { "application/json;charset=UTF-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AuthenticationCredentials" }, { "description": "credentials" } ] } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/AuthenticationToken" } } } } }, "deprecated": false } }, "/users/logout": { "post": { "tags": [ "Authentication" ], "summary": "logoutUsersUsingPOST", "description": "Logout the User", "operationId": "logoutUsersUsingPOST", "parameters": [ { "name": "name", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } } ], "requestBody": { "description": "token", "content": { "application/json;charset=UTF-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AuthenticationToken" }, { "description": "token" } ] } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": {} } }, "deprecated": false } }, "/login": { "post": { "tags": [ "Authentication" ], "summary": "login", "description": "Login a user and create a session", "operationId": "login", "parameters": [], "requestBody": { "description": "Authenication Credentials", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AuthenticationCredentials" }, { "description": "Authenication Credentials" } ] } } }, "required": true }, "responses": { "200": { "description": "Successful response", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "403": { "description": "Forbidden", "headers": {}, "content": {} }, "404": { "description": "The specified resource was not found", "headers": {}, "content": {} } }, "deprecated": false } }, "/oauth/login": { "post": { "tags": [ "Authentication" ], "summary": "oauthLogin", "description": "Login a user with OAuth authentication token and create a session", "operationId": "oauthLogin", "parameters": [], "requestBody": { "description": "OAuth Authenication Token", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AuthenticationOAuthToken" }, { "description": "OAuth Authenication Token" } ] } } }, "required": true }, "responses": { "200": { "description": "Successful response", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "403": { "description": "Forbidden", "headers": {}, "content": {} }, "404": { "description": "The specified resource was not found", "headers": {}, "content": {} } }, "deprecated": false } }, "/logout": { "get": { "tags": [ "Authentication" ], "summary": "logout", "description": "Logout a user from a session", "operationId": "logout", "parameters": [], "responses": { "200": { "description": "Successful response", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "403": { "description": "Forbidden", "headers": {}, "content": {} }, "404": { "description": "The specified resource was not found", "headers": {}, "content": {} } }, "deprecated": false } }, "/sessions": { "post": { "tags": [ "Authentication" ], "summary": "createSession", "description": "Creates a new session", "operationId": "createSession", "parameters": [], "requestBody": { "description": "A valid 'AuthenticationToken' obtained using the Login API", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AuthenticationToken" }, { "description": "A valid 'AuthenticationToken' obtained using the Login API" } ] } } }, "required": true }, "responses": { "201": { "description": "Successful response.", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "403": { "description": "Forbidden", "headers": {}, "content": {} } }, "deprecated": false }, "delete": { "tags": [ "Authentication" ], "summary": "deleteSession", "description": "Delete the session", "operationId": "deleteSession", "parameters": [], "responses": { "201": { "description": "Successful response.", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "403": { "description": "Forbidden", "headers": {}, "content": {} } }, "deprecated": false } }, "/otp/login": { "post": { "tags": [ "Authentication" ], "summary": "otpLogin", "description": "Login a user with a One Time Password and create a session", "operationId": "otpLogin", "parameters": [ { "name": "otp", "in": "query", "description": "The one time password used to log in", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "403": { "description": "Forbidden", "headers": {}, "content": {} }, "404": { "description": "The specified resource was not found", "headers": {}, "content": {} } }, "deprecated": false } }, "/tenantnetworks/{tenantNetworkId}/segments": { "get": { "tags": [ "Segments" ], "summary": "getsegments", "description": "Get a list of all Segments", "operationId": "getsegments", "parameters": [ { "name": "tenantNetworkId", "in": "path", "description": "The id of the tenant network", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int64", "example": 44 } } ], "responses": { "200": { "description": "Successful response - returns an array of `Segment` entities.", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Segment" }, "description": "" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "403": { "description": "Forbidden", "headers": {}, "content": {} }, "404": { "description": "The specified resource was not found", "headers": {}, "content": {} } }, "deprecated": false }, "post": { "tags": [ "Segments" ], "summary": "createSegment", "description": "Creates a new Segment.", "operationId": "createSegment", "parameters": [ { "name": "tenantNetworkId", "in": "path", "description": "The id of the tenant network", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int64", "example": 44 } } ], "requestBody": { "description": "A new `Segment` to be created.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Segment" }, { "description": "A new `Segment` to be created." } ] } } }, "required": true }, "responses": { "201": { "description": "Successful response.", "headers": {}, "content": {} }, "400": { "description": "A list of errors which provide detailed information on bad input", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ErrorDetails" }, { "description": "ErrorDetails give a more detailed description on issues with the input when a 400 status code is returned" } ] } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "403": { "description": "Forbidden", "headers": {}, "content": {} }, "404": { "description": "The specified resource was not found", "headers": {}, "content": {} } }, "deprecated": false } }, "/tenantnetworks/{tenantNetworkId}/segments/{segmentId}": { "get": { "tags": [ "Segments" ], "summary": "getSegment", "description": "Gets the details of a single Segment", "operationId": "getSegment", "parameters": [ { "name": "tenantNetworkId", "in": "path", "description": "The id of the tenant network", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int64", "example": 44 } }, { "name": "segmentId", "in": "path", "description": "A unique identifier for a 'Segment'", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Successful response - returns a single `Segment`.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Segment" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "403": { "description": "Forbidden", "headers": {}, "content": {} }, "404": { "description": "The specified resource was not found", "headers": {}, "content": {} } }, "deprecated": false }, "put": { "tags": [ "Segments" ], "summary": "updateSegment", "description": "Updates an existing Segment", "operationId": "updateSegment", "parameters": [ { "name": "tenantNetworkId", "in": "path", "description": "The id of the tenant network", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int64", "example": 44 } }, { "name": "segmentId", "in": "path", "description": "A unique identifier for a 'Segment'", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Updated `Segment` information.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Segment" }, { "description": "Updated `Segment` information." } ] } } }, "required": true }, "responses": { "200": { "description": "Successful response.", "headers": {}, "content": {} }, "400": { "description": "A list of errors which provide detailed information on bad input", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ErrorDetails" }, { "description": "ErrorDetails give a more detailed description on issues with the input when a 400 status code is returned" } ] } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "403": { "description": "Forbidden", "headers": {}, "content": {} }, "404": { "description": "The specified resource was not found", "headers": {}, "content": {} } }, "deprecated": false }, "delete": { "tags": [ "Segments" ], "summary": "deleteSegment", "description": "Deletes an existing Segment.", "operationId": "deleteSegment", "parameters": [ { "name": "tenantNetworkId", "in": "path", "description": "The id of the tenant network", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int64", "example": 44 } }, { "name": "segmentId", "in": "path", "description": "A unique identifier for a 'Segment'", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Successful response.", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "403": { "description": "Forbidden", "headers": {}, "content": {} }, "404": { "description": "The specified resource was not found", "headers": {}, "content": {} } }, "deprecated": false } }, "/tenantnetworks/{tenantNetworkId}/groups": { "get": { "tags": [ "Groups" ], "summary": "getgroups", "description": "Gets a list of all `groups` entities.", "operationId": "getgroups", "parameters": [ { "name": "tenantNetworkId", "in": "path", "description": "A unique identifier for a 'Network'", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int64" } }, { "name": "segmentId", "in": "query", "description": "filter groups which are associated with a specific segment. When only segmentId is passed as a query param the Groups that are returned are of type IMPLICIT/EXPLICIT where the IMPLICIT Groups are associated with Connectors that are on this segment and where EXPLICIT Groups contain Connectors which are on this segment.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "serviceId", "in": "query", "description": "filter groups which are applicable to zones. When serviceId is passed as a query param, segmentId MUST also be passed. Filtering groups by serviceId and segmentId returns groups which are of type EXPLICIT, USER_GROUP and SEGMENT_RESOURCE. The EXPLICIT Groups are associated with Connectors on the same segment as segmentId and SEGMENT_RESOURCE groups are associated with SegmentResources which are either associated with ANY Service or the same Service as serviceId.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "groupTypes", "in": "query", "description": "The specific types of groups to filter on", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/groupType" } } } ], "responses": { "200": { "description": "Successful response - returns an array of `groups` entities.", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RootTypeforgroups" }, "description": "" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "403": { "description": "Forbidden", "headers": {}, "content": {} }, "404": { "description": "The specified resource was not found", "headers": {}, "content": {} } }, "deprecated": false }, "post": { "tags": [ "Groups" ], "summary": "creategroups", "description": "Creates a new instance of a `groups`.", "operationId": "creategroups", "parameters": [ { "name": "tenantNetworkId", "in": "path", "description": "A unique identifier for a 'Network'", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "A new `groups` to be created.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RootTypeforgroups" }, { "description": "A new `groups` to be created." } ] } } }, "required": true }, "responses": { "201": { "description": "Successful response.", "headers": {}, "content": {} }, "400": { "description": "A list of errors which provide detailed information on bad input", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ErrorDetails" }, { "description": "ErrorDetails give a more detailed description on issues with the input when a 400 status code is returned" } ] } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "403": { "description": "Forbidden", "headers": {}, "content": {} }, "404": { "description": "The specified resource was not found", "headers": {}, "content": {} } }, "deprecated": false } }, "/tenantnetworks/{tenantNetworkId}/groups/{groupId}": { "get": { "tags": [ "Groups" ], "summary": "getgroup", "description": "Gets the details of a single instance of a `groups`.", "operationId": "getgroup", "parameters": [ { "name": "tenantNetworkId", "in": "path", "description": "The id of the tenant network", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int64", "example": 44 } }, { "name": "groupId", "in": "path", "description": "A unique identifier for a 'Group'", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Successful response - returns a single `groups`.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RootTypeforgroups" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "403": { "description": "Forbidden", "headers": {}, "content": {} }, "404": { "description": "The specified resource was not found", "headers": {}, "content": {} } }, "deprecated": false }, "put": { "tags": [ "Groups" ], "summary": "updategroups", "description": "Updates an existing `groups`.", "operationId": "updategroups", "parameters": [ { "name": "tenantNetworkId", "in": "path", "description": "The id of the tenant network", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int64", "example": 44 } }, { "name": "groupId", "in": "path", "description": "A unique identifier for a 'Group'", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Updated `groups` information.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RootTypeforgroups" }, { "description": "Updated `groups` information." } ] } } }, "required": true }, "responses": { "200": { "description": "Successful response.", "headers": {}, "content": {} }, "400": { "description": "A list of errors which provide detailed information on bad input", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ErrorDetails" }, { "description": "ErrorDetails give a more detailed description on issues with the input when a 400 status code is returned" } ] } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "403": { "description": "Forbidden", "headers": {}, "content": {} }, "404": { "description": "The specified resource was not found", "headers": {}, "content": {} } }, "deprecated": false }, "delete": { "tags": [ "Groups" ], "summary": "deletegroups", "description": "Deletes an existing `groups`.", "operationId": "deletegroups", "parameters": [ { "name": "tenantNetworkId", "in": "path", "description": "The id of the tenant network", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int64", "example": 44 } }, { "name": "groupId", "in": "path", "description": "A unique identifier for a 'Group'", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Successful response.", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "403": { "description": "Forbidden", "headers": {}, "content": {} }, "404": { "description": "The specified resource was not found", "headers": {}, "content": {} } }, "deprecated": false } }, "/users": { "get": { "tags": [ "Users" ], "summary": "getAllUsersUsingGET", "description": "List all Users", "operationId": "getAllUsersUsingGET", "parameters": [ { "name": "userName", "in": "query", "description": "Query param for 'userName' filter", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "active", "in": "query", "description": "Query param for 'active' filter", "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json;charset=UTF-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/User" }, "description": "" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "403": { "description": "Forbidden", "headers": {}, "content": {} }, "404": { "description": "The specified resource was not found", "headers": {}, "content": {} } }, "deprecated": false }, "post": { "tags": [ "Users" ], "summary": "createUsersUsingPOST", "description": "Create a User", "operationId": "createUsersUsingPOST", "parameters": [], "requestBody": { "description": "", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/User" } } }, "required": false }, "responses": { "201": { "description": "OK", "headers": {}, "content": { "application/json;charset=UTF-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/User" }, { "description": "A user may be a local user i.e users that are natively created on the Alkira system or users that were added to the Alkira system when they logged in via an external identity provider" } ] } } } }, "400": { "description": "A list of errors which provide detailed information on bad input", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ErrorDetails" }, { "description": "ErrorDetails give a more detailed description on issues with the input when a 400 status code is returned" } ] } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "403": { "description": "Forbidden", "headers": {}, "content": {} }, "404": { "description": "The specified resource was not found", "headers": {}, "content": {} } }, "deprecated": false } }, "/users/{userId}": { "get": { "tags": [ "Users" ], "summary": "getUsersByIdUsingGET", "description": "Get a User", "operationId": "getUsersByIdUsingGET", "parameters": [ { "name": "name", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "description": "userId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json;charset=UTF-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/User" }, { "description": "A user may be a local user i.e users that are natively created on the Alkira system or users that were added to the Alkira system when they logged in via an external identity provider" } ] } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "403": { "description": "Forbidden", "headers": {}, "content": {} }, "404": { "description": "The specified resource was not found", "headers": {}, "content": {} } }, "deprecated": false }, "put": { "tags": [ "Users" ], "summary": "updateUsersByIdUsingPUT", "description": "Update a User", "operationId": "updateUsersByIdUsingPUT", "parameters": [ { "name": "userId", "in": "path", "description": "userId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/User" } } }, "required": false }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json;charset=UTF-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/User" }, { "description": "A user may be a local user i.e users that are natively created on the Alkira system or users that were added to the Alkira system when they logged in via an external identity provider" } ] } } } }, "400": { "description": "A list of errors which provide detailed information on bad input", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ErrorDetails" }, { "description": "ErrorDetails give a more detailed description on issues with the input when a 400 status code is returned" } ] } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "403": { "description": "Forbidden", "headers": {}, "content": {} }, "404": { "description": "The specified resource was not found", "headers": {}, "content": {} } }, "deprecated": false }, "delete": { "tags": [ "Users" ], "summary": "deleteUsersByIdUsingDELETE", "description": "Delete a User", "operationId": "deleteUsersByIdUsingDELETE", "parameters": [ { "name": "name", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "description": "userId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "403": { "description": "Forbidden", "headers": {}, "content": {} } }, "deprecated": false } }, "/userprofile": { "get": { "tags": [ "Users" ], "summary": "getUserProfileUsingGET", "description": "Get a User Profile", "operationId": "getUserProfileUsingGET", "parameters": [ { "name": "name", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/UserProfile" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "403": { "description": "Forbidden", "headers": {}, "content": {} }, "404": { "description": "The specified resource was not found", "headers": {}, "content": {} } }, "deprecated": false }, "put": { "tags": [ "Users" ], "summary": "updateUserProfileUsingPUT", "description": "Update a User Profile", "operationId": "updateUserProfileUsingPUT", "parameters": [ { "name": "name", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } } ], "requestBody": { "description": "userProfile", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UserProfile" }, { "description": "userProfile" } ] } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/UserProfile" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "403": { "description": "Forbidden", "headers": {}, "content": {} }, "404": { "description": "The specified resource was not found", "headers": {}, "content": {} } }, "deprecated": false } }, "/user-groups": { "get": { "tags": [ "UserGroups" ], "summary": "getusergroups", "description": "Gets a list of all `UserGroup` entities.", "operationId": "getusergroups", "parameters": [], "responses": { "200": { "description": "Successful response - returns an array of `UserGroup` entities.", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RootTypeforUserGroup" }, "description": "" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "403": { "description": "Forbidden", "headers": {}, "content": {} }, "404": { "description": "The specified resource was not found", "headers": {}, "content": {} } }, "deprecated": false }, "post": { "tags": [ "UserGroups" ], "summary": "createUserGroup", "description": "Creates a new instance of a `UserGroup`.", "operationId": "createUserGroup", "parameters": [], "requestBody": { "description": "A new `UserGroup` to be created.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RootTypeforUserGroup" }, { "description": "A new `UserGroup` to be created." } ] } } }, "required": true }, "responses": { "201": { "description": "Successful response.", "headers": {}, "content": {} }, "400": { "description": "A list of errors which provide detailed information on bad input", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ErrorDetails" }, { "description": "ErrorDetails give a more detailed description on issues with the input when a 400 status code is returned" } ] } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "403": { "description": "Forbidden", "headers": {}, "content": {} }, "404": { "description": "The specified resource was not found", "headers": {}, "content": {} } }, "deprecated": false } }, "/user-groups/{usergroupId}": { "get": { "tags": [ "UserGroups" ], "summary": "getUserGroup", "description": "Gets the details of a single instance of a `UserGroup`.", "operationId": "getUserGroup", "parameters": [ { "name": "usergroupId", "in": "path", "description": "A unique identifier for a `UserGroup`.", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful response - returns a single `UserGroup`.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RootTypeforUserGroup" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "403": { "description": "Forbidden", "headers": {}, "content": {} }, "404": { "description": "The specified resource was not found", "headers": {}, "content": {} } }, "deprecated": false }, "put": { "tags": [ "UserGroups" ], "summary": "updateUserGroup", "description": "Updates an existing `UserGroup`.", "operationId": "updateUserGroup", "parameters": [ { "name": "usergroupId", "in": "path", "description": "A unique identifier for a `UserGroup`.", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "Updated `UserGroup` information.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RootTypeforUserGroup" }, { "description": "Updated `UserGroup` information." } ] } } }, "required": true }, "responses": { "200": { "description": "Successful response.", "headers": {}, "content": {} }, "400": { "description": "A list of errors which provide detailed information on bad input", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ErrorDetails" }, { "description": "ErrorDetails give a more detailed description on issues with the input when a 400 status code is returned" } ] } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "403": { "description":