{"openapi":"3.0.0","info":{"title":"A&A REST API","description":"CRUD operations on Clients, Users, Groups, Roles and Permissions.\n","contact":{"name":"Compart Customer Support","email":"support@compart.com","url":"https://www.compart.com/"},"version":"1.7.2"},"servers":[{"url":"https://localhost:8446/","description":"Local test server"}],"tags":[{"name":"oauth2","description":"All OAuth2 services"},{"name":"loginlogout","description":"Login/Logout services"},{"name":"info","description":"All information about application state and configuration"},{"name":"clients","description":"All services for managing Clients"},{"name":"users","description":"All services for managing Users"},{"name":"users-relationships","description":"All services for managing Users relationships"},{"name":"groups","description":"All services for managing Groups"},{"name":"groups-relationships","description":"All services for managing Groups relationships"},{"name":"roles","description":"All services for managing Roles"},{"name":"roles-relationships","description":"All services for managing Roles relationships"},{"name":"permissions","description":"All services for managing Permissions"},{"name":"permissions-relationships","description":"All services for managing Permissions relationships"}],"paths":{"/AuthenticationAndAuthorization/oauth/token":{"post":{"tags":["oauth2"],"summary":"Get an OAuth2 JWT token","security":[{"BasicAuth":[]}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"username":{"type":"string","example":"bob"},"password":{"type":"string","example":"alice_sweetheart"},"grant_type":{"type":"string","example":"password"},"scope":{"type":"string","example":"webclient"},"client_id":{"type":"string","example":"pom"},"client_secret":{"type":"string","example":"secret_for_pom"}},"required":["grant_type","scope"]}}}},"responses":{"200":{"description":"JWT containing the OAuth2 token","content":{"application/json":{"schema":{"type":"object","properties":{"access_token":{"type":"string","example":"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1NTMxNzUxNzAsInVzZXJfbmFtZSI6InRlc3QiLCJhdXRob3JpdGllcyI6WyJST0xFX0FOQV9VU0VSIiwiUk9MRV9BRE1JTiIsIlJPTEVfQU5BX0FETUlOIiwiUk9MRV9VU0VSIl0sImp0aSI6IjlkMDkyN2I3LTFkYjItNDUyNC04ZWIxLWQ0ZmViZWRkYzY3ZSIsImNsaWVudF9pZCI6InJlc3QiLCJzY29wZSI6WyJ3ZWJjbGllbnQiXX0.kRP0XS4A4dC6avBiBPftDJ9FAe4NmhyDdUQ_VRCfdXnikiuKnN7Nr-BqoJsjfr5EUdLCPwqhxWU24MfFflvH5bMhAEuu8TaK87H39VILwS6A_Iqk9LMEkGBbxiujlDEqaWWfTCx3y8UxHextIkdDa3PgsrI0B9OXJZRR5V0mWx-O4yzAYPD99ENpH8EfxEwWtr7NjbBI3C0mWbn7FZ9IQBsMXx_QdypqznkYkDfBmr8jtg9XJgEBvBcK2GTMSUXOrQQ3d4-ja6GbQOFdOlrSf45oPDoebY4RyimZdBvWYcvPERX5AjdujcrPO4Y1pvs0cF5ll3o_5cHRlDaU-vyU2Q"},"token_type":{"type":"string","example":"bearer"},"refresh_token":{"type":"string","example":"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJ0ZXN0Iiwic2NvcGUiOlsid2ViY2xpZW50Il0sImF0aSI6IjlkMDkyN2I3LTFkYjItNDUyNC04ZWIxLWQ0ZmViZWRkYzY3ZSIsImV4cCI6MTU1NTc2MzU3MCwiYXV0aG9yaXRpZXMiOlsiUk9MRV9BTkFfVVNFUiIsIlJPTEVfQURNSU4iLCJST0xFX0FOQV9BRE1JTiIsIlJPTEVfVVNFUiJdLCJqdGkiOiIyMjYyYzYyYS0zYzZmLTQ1N2MtOWNjMi1hMjcyMzQyNmQ4YTMiLCJjbGllbnRfaWQiOiJyZXN0In0.PUCCS6SMHD-9_pHu2YrKJPikHAJFxU5ZtaL7r3qWBsxNv3AQZAazT5cPXOvOeItvWbuska_bpfGt2a5va23TqjgkXzAprGQIKjTBX2jCbCWys0VnRU4b90WyJSrPCBaaW6ln1DLVo-g6fAHhw349emg9zs-m8Q5xQGPxFDLuUKH2YWi6vFdOq9vBKgGnmsDuU4cgVcl0qSsBaIpTXYFABOTSakB_hvXcJa8x7Zhs5gEznV5sy-5Knae0EFykCvhD1TajNU3VPBszAmdsSWq_pAh7UHjqWGO7EjZaYGiTxytU-xjMKCEeNtWgGokQ3Ed6aefMAKbON7mR_4KCyFKUUg"},"expires_in":{"type":"integer","example":3599},"scope":{"type":"string","example":"webclient"},"jti":{"type":"string","example":"9d0927b7-1db2-4524-8eb1-d4febeddc67e"}}}}}},"400":{"description":"The given username/password pair does not exist"},"401":{"description":"The given client_id/client_secret pair does not exist"}}}},"/AuthenticationAndAuthorization/oauth/token_key":{"get":{"tags":["oauth2"],"summary":"Get the key to check OAuth2 JWT token signature","security":[{"BasicAuth":[]}],"responses":{"200":{"description":"JSON containing the OAuth2 JWT token signature checking key","content":{"application/json":{"schema":{"type":"object","properties":{"alg":{"type":"string","example":"SHA256withRSA"},"value":{"type":"string","example":"-----BEGIN PUBLIC KEY-----\\nMIIBIjANBgjqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArAwILINHmKgAEv5pQDrkDbjDqUOryvQ+DFPnn6oZIpiyiIaoQrji/7VGMmYZWG7/BQwou7PUCF+yDXs2Scs2i/19yyITZAtMPek0CxlmTlWEgHTZYZVrwWLBaOXTSZhwFP2XI18Cd9GHCr7FnvFSZAVLYZ3vH4ph43YBiO/p1/n3CWHlcBemm6VLXKsuLK1jKvMlY8TqaOcGTNGcjOhyv7rU39lPMJWF5a9R52EsfSuhtiXZY9Fqbcd9IzML5ldk7eNATYGRZdKHXqo8+8py+82kxmLnOwtMiyrMxdYs4NB+TFdaQMhFiW1NY+TykavQqyFAjqvQcJ1SmRoCRduPMwIDAQAB\\n-----END PUBLIC KEY-----"}}}}}},"401":{"description":"The client_id/client_secret pair (given in the Authorization header) does not exist"}}}},"/AuthenticationAndAuthorization/.well-known/jwks.json":{"get":{"tags":["oauth2"],"summary":"Get the jwk set to check OAuth2 JWT token signature (new way to check token signature)","responses":{"200":{"description":"The JSON key set (can contain multiple keys) to check the OAuth2 JWT token signature","content":{"application/json":{"schema":{"type":"object","properties":{"keys":{"type":"array","items":{"type":"object","properties":{"kty":{"type":"string","example":"RSA"},"e":{"type":"string","example":"AQAB"},"use":{"type":"string","example":"sig"},"kid":{"type":"string","example":"jwt"},"n":{"type":"string","example":"hdNENpw6JbzBHXGiPgqifdZMNd8Hvn_vb6jl9noKHk6kX71LqV2mWvGc_52-X9Ipuxia2VUxFueYD55xS0a-12oY-0oKsYY0DBSk3W7UcMj31UddEPbmWKUDCjeiApoUdC3biNHLg67XSBed60A1k23kY24kxkprCPVAeXgu6Dc"}}}}}}}}}}}},"/AuthenticationAndAuthorization/login":{"get":{"tags":["loginlogout"],"summary":"Login endpoint that only redirects to the login html, only used in the context of the authorization_code flow","responses":{"302":{"description":"Redirect to the html login page"}}}},"/AuthenticationAndAuthorization/login/check":{"get":{"tags":["loginlogout"],"summary":"Check if a user is logged in in the current browser session and return the username","responses":{"200":{"description":"Return the username if the user is logged in, or empty value if not","content":{"application/json":{"schema":{"type":"string","example":"testinger"}}}}}}},"/AuthenticationAndAuthorization/logout":{"get":{"tags":["loginlogout"],"summary":"Logout the user from the current browser session, with redirect if needed","parameters":[{"name":"redirect_uri","in":"query","description":"URI to redirect to after the logout","schema":{"type":"string","example":"http://localhost:8082/"},"required":false}],"responses":{"302":{"description":"Logout the user from the current browser session and redirect to the provided url (or back to the login page if no redirect_uri parameter is provided)"}}}},"/AuthenticationAndAuthorization/api/v1/clients":{"get":{"tags":["clients"],"summary":"List of all clients","security":[{"BasicAuth":[]},{"OAuth2":["ANA_USER","ANA_ADMIN"]}],"responses":{"200":{"description":"List all clients","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["links","data"],"properties":{"jsonapi":{"$ref":"#/components/schemas/jsonapi"},"meta":{"$ref":"#/components/schemas/meta"},"links":{"$ref":"#/components/schemas/ClientLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ClientDataWithHashedSecret"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"}}},"post":{"tags":["clients"],"summary":"Create a client","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"requestBody":{"description":"The JSON:API representation of the client to create","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ClientData"}}}}}},"responses":{"201":{"description":"The client with the given id was created","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["links","data"],"properties":{"jsonapi":{"$ref":"#/components/schemas/jsonapi"},"meta":{"$ref":"#/components/schemas/meta"},"links":{"$ref":"#/components/schemas/ClientLinks"},"data":{"$ref":"#/components/schemas/ClientDataWithHashedSecret"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"409":{"$ref":"#/components/responses/ConflictError"}}}},"/AuthenticationAndAuthorization/api/v1/clients/{id}":{"parameters":[{"name":"id","in":"path","required":true,"description":"Id of the client (unique)","schema":{"type":"string","example":"pom"}}],"get":{"tags":["clients"],"summary":"Get the details about a client","security":[{"BasicAuth":[]},{"OAuth2":["ANA_USER","ANA_ADMIN"]}],"responses":{"200":{"description":"The client was successfully read","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["links","data"],"properties":{"jsonapi":{"$ref":"#/components/schemas/jsonapi"},"meta":{"$ref":"#/components/schemas/meta"},"links":{"$ref":"#/components/schemas/ClientLinks"},"data":{"$ref":"#/components/schemas/ClientDataWithHashedSecret"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"}}},"delete":{"tags":["clients"],"summary":"Delete a client","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"responses":{"200":{"description":"The client with the given name was deleted","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["links","data"],"properties":{"jsonapi":{"$ref":"#/components/schemas/jsonapi"},"meta":{"$ref":"#/components/schemas/meta"},"links":{"$ref":"#/components/schemas/ClientLinks"},"data":{"$ref":"#/components/schemas/ClientDataWithHashedSecret"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundError"}}},"put":{"tags":["clients"],"summary":"Replace a client","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"requestBody":{"description":"The JSON:API representation of the client to replace","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ClientDataWithoutId"}}}}}},"responses":{"201":{"description":"The client with the given name was replaced","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["links","data"],"properties":{"jsonapi":{"$ref":"#/components/schemas/jsonapi"},"meta":{"$ref":"#/components/schemas/meta"},"links":{"$ref":"#/components/schemas/ClientLinks"},"data":{"$ref":"#/components/schemas/ClientDataWithHashedSecret"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundError"}}},"patch":{"tags":["clients"],"summary":"Modify specific properties of a client","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"requestBody":{"description":"The JSON representation of the client, containing only the attributes to be updated","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ClientDataWithoutId"}}}}}},"responses":{"200":{"description":"The client attributes were updated","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"jsonapi":{"$ref":"#/components/schemas/jsonapi"},"meta":{"$ref":"#/components/schemas/meta"},"links":{"$ref":"#/components/schemas/ClientLinks"},"data":{"$ref":"#/components/schemas/ClientDataWithHashedSecret"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundError"}}}},"/AuthenticationAndAuthorization/api/v1/users":{"get":{"tags":["users"],"summary":"List users","security":[{"BasicAuth":[]},{"OAuth2":["ANA_USER","ANA_ADMIN"]}],"parameters":[{"name":"include","in":"query","required":false,"description":"Related objects to include. See also [JSON:API Specification - Includes](https://jsonapi.org/format/1.1/#fetching-includes)","schema":{"type":"array","items":{"type":"string"}},"explode":false,"example":["groups","roles"]},{"name":"sort","in":"query","required":false,"description":"The sort criteria for the returned data, as a comma-separated list. For descending order, the criteria must be preceded by a minus sign (\"-\"). See also [JSON:API Specification - Sorting](https://jsonapi.org/format/1.1/#fetching-sorting)","schema":{"type":"array","items":{"type":"string"}},"explode":false,"example":["id","displayName","-organization","location","-telephone","-email"]},{"name":"page[number]","in":"query","required":false,"description":"The pagination offset. See also [JSON:API Specification - Pagination](https://jsonapi.org/format/1.1/#fetching-pagination) and [JSON:API Specification - Query Parameter Families](https://jsonapi.org/format/1.1/#query-parameters-families)","schema":{"type":"integer","example":1}},{"name":"page[size]","in":"query","required":false,"description":"The pagination limit. See also [JSON:API Specification - Pagination](https://jsonapi.org/format/1.1/#fetching-pagination) and [JSON:API Specification - Query Parameter Families](https://jsonapi.org/format/1.1/#query-parameters-families)","schema":{"type":"integer","example":100}}],"responses":{"200":{"description":"List users (if pagination is not specified, the first page with 25 elements is returned)","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["links","data"],"properties":{"jsonapi":{"$ref":"#/components/schemas/jsonapi"},"meta":{"$ref":"#/components/schemas/metaWithTotalNumber"},"links":{"$ref":"#/components/schemas/UserLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/UserDataWithRelationships"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/UserToInclude"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"}}},"post":{"tags":["users"],"summary":"Create a user","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"requestBody":{"description":"The JSON:API representation of the user to create","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/UserData"}}}}}},"responses":{"201":{"description":"The user with the given name was created","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["links","data"],"properties":{"jsonapi":{"$ref":"#/components/schemas/jsonapi"},"meta":{"$ref":"#/components/schemas/meta"},"links":{"$ref":"#/components/schemas/UserLinks"},"data":{"$ref":"#/components/schemas/UserDataWithEmptyRelationships"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"409":{"$ref":"#/components/responses/ConflictError"}}}},"/AuthenticationAndAuthorization/api/v1/users/{name}":{"parameters":[{"name":"name","in":"path","required":true,"description":"Name of the user (unique)","schema":{"type":"string","example":"john"}}],"get":{"tags":["users"],"summary":"Get the details about a single user","security":[{"BasicAuth":[]},{"OAuth2":["ANA_USER","ANA_ADMIN"]}],"parameters":[{"name":"include","in":"query","required":false,"description":"Related objects to include. See also [JSON:API Specification - Includes](https://jsonapi.org/format/1.1/#fetching-includes)","schema":{"type":"array","items":{"type":"string"}},"explode":false,"example":["groups","roles"]}],"responses":{"200":{"description":"The user was successfully read","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["links","data"],"properties":{"jsonapi":{"$ref":"#/components/schemas/jsonapi"},"meta":{"$ref":"#/components/schemas/meta"},"links":{"$ref":"#/components/schemas/UserLinks"},"data":{"$ref":"#/components/schemas/UserDataWithRelationships"},"included":{"type":"array","items":{"$ref":"#/components/schemas/UserToInclude"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"}}},"delete":{"tags":["users"],"summary":"Delete a user","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"responses":{"200":{"description":"The user with the given name was deleted","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["links","data"],"properties":{"jsonapi":{"$ref":"#/components/schemas/jsonapi"},"meta":{"$ref":"#/components/schemas/meta"},"data":{"$ref":"#/components/schemas/UserDataWithoutPassword"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundError"}}},"put":{"tags":["users"],"summary":"Replace a user","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"parameters":[{"name":"include","in":"query","required":false,"description":"Related objects to include. See also [JSON:API Specification - Includes](https://jsonapi.org/format/1.1/#fetching-includes)","schema":{"type":"array","items":{"type":"string"}},"explode":false,"example":["groups","roles"]}],"requestBody":{"description":"The JSON:API representation of the user to replace","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/UserDataWithoutId"}}}}}},"responses":{"200":{"description":"The user with the given name was replaced","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["links","data"],"properties":{"jsonapi":{"$ref":"#/components/schemas/jsonapi"},"meta":{"$ref":"#/components/schemas/meta"},"links":{"$ref":"#/components/schemas/UserLinks"},"data":{"$ref":"#/components/schemas/UserDataWithRelationships"},"included":{"type":"array","items":{"$ref":"#/components/schemas/UserToInclude"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundError"}}},"patch":{"tags":["users"],"summary":"Modify specific properties of a user","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"parameters":[{"name":"include","in":"query","required":false,"description":"Related objects to include. See also [JSON:API Specification - Includes](https://jsonapi.org/format/1.1/#fetching-includes)","schema":{"type":"array","items":{"type":"string"}},"explode":false,"example":["groups","roles"]}],"requestBody":{"description":"The JSON representation of the user, containing only the attributes to be updated","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/UserDataWithoutId"}}}}}},"responses":{"200":{"description":"The user attributes were updated","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"jsonapi":{"$ref":"#/components/schemas/jsonapi"},"meta":{"$ref":"#/components/schemas/meta"},"links":{"$ref":"#/components/schemas/UserLinks"},"data":{"$ref":"#/components/schemas/UserDataWithRelationships"},"included":{"type":"array","items":{"$ref":"#/components/schemas/UserToInclude"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundError"}}},"post":{"tags":["users"],"summary":"Change the password","security":[{"BasicAuth":[]},{"OAuth2":["ANA_USER"]}],"requestBody":{"description":"The JSON containing the old and the new password","content":{"application/json":{"schema":{"type":"object","required":["oldPassword","newPassword"],"properties":{"oldPassword":{"type":"string","example":"changeit"},"newPassword":{"type":"string","example":"changed_it"}}}}}},"responses":{"200":{"description":"The user's password was successfuly changed","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"jsonapi":{"$ref":"#/components/schemas/jsonapi"},"meta":{"$ref":"#/components/schemas/meta"},"links":{"$ref":"#/components/schemas/UserLinks"},"data":{"$ref":"#/components/schemas/UserDataWithoutPassword"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundError"}}}},"/AuthenticationAndAuthorization/api/v1/users/{userName}/relationships/groups":{"parameters":[{"name":"userName","in":"path","required":true,"description":"Name of the user (unique)","schema":{"type":"string","example":"john"}}],"get":{"tags":["users-relationships"],"summary":"List all user-group relationships","security":[{"BasicAuth":[]},{"OAuth2":["ANA_USER","ANA_ADMIN"]}],"responses":{"200":{"description":"List all user-group relationships for the specified user","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/UserGroupRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/groupResourceObjectIdentifier"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"}}},"delete":{"tags":["users-relationships"],"summary":"Delete user-group relationships for the specified user","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"requestBody":{"description":"The JSON:API representation of the user-group relationships to delete","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/groupResourceObjectIdentifier"}}}}}}},"responses":{"200":{"description":"Deleted user-group relationships for the specified user","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/UserGroupRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/groupResourceObjectIdentifier"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"}}},"post":{"tags":["users-relationships"],"summary":"Add user-group relationships","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"requestBody":{"description":"The JSON:API representation of the user-group relationships to add","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/groupResourceObjectIdentifier"}}}}}}},"responses":{"200":{"description":"Created user-group relationships for the specified user","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/UserGroupRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/groupResourceObjectIdentifier"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"},"409":{"$ref":"#/components/responses/ConflictError"}}},"patch":{"tags":["users-relationships"],"summary":"Replace user-group relationships","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"requestBody":{"description":"The JSON:API representation of the user-group relationships","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/groupResourceObjectIdentifier"}}}}}}},"responses":{"200":{"description":"The updated user-group relationships for the specified user","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/UserGroupRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/groupResourceObjectIdentifier"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"}}}},"/AuthenticationAndAuthorization/api/v1/users/{userName}/relationships/roles":{"parameters":[{"name":"userName","in":"path","required":true,"description":"Name of the user (unique)","schema":{"type":"string","example":"john"}}],"get":{"tags":["users-relationships"],"summary":"List all user-role relationships","security":[{"BasicAuth":[]},{"OAuth2":["ANA_USER","ANA_ADMIN"]}],"responses":{"200":{"description":"List all user-role relationships for the specified user","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/UserRoleRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/roleResourceObjectIdentifier"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"}}},"delete":{"tags":["users-relationships"],"summary":"Delete user-role relationships for the specified user","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"requestBody":{"description":"The JSON:API representation of the user-role relationships to delete","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/roleResourceObjectIdentifier"}}}}}}},"responses":{"200":{"description":"Deleted user-role relationships for the specified user","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/UserRoleRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/roleResourceObjectIdentifier"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"}}},"post":{"tags":["users-relationships"],"summary":"Add user-role relationships","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"requestBody":{"description":"The JSON:API representation of the user-role relationships to add","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/roleResourceObjectIdentifier"}}}}}}},"responses":{"200":{"description":"Created user-role relationships for the specified user","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/UserRoleRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/roleResourceObjectIdentifier"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"},"409":{"$ref":"#/components/responses/ConflictError"}}},"patch":{"tags":["users-relationships"],"summary":"Replace user-role relationships","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"requestBody":{"description":"The JSON:API representation of the user-role relationships","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/roleResourceObjectIdentifier"}}}}}}},"responses":{"200":{"description":"The updated user-role relationships for the specified user","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/UserRoleRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/roleResourceObjectIdentifier"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"}}}},"/AuthenticationAndAuthorization/api/v1/groups":{"get":{"tags":["groups"],"summary":"List groups","security":[{"BasicAuth":[]},{"OAuth2":["ANA_USER","ANA_ADMIN"]}],"parameters":[{"name":"include","in":"query","required":false,"description":"Related objects to include. See also [JSON:API Specification - Includes](https://jsonapi.org/format/1.1/#fetching-includes)","schema":{"type":"array","items":{"type":"string"}},"explode":false,"example":["users","groups","roles"]},{"name":"sort","in":"query","required":false,"description":"The sort criteria for the returned data, as a comma-separated list. For descending order, the criteria must be preceded by a minus sign (\"-\"). See also [JSON:API Specification - Sorting](https://jsonapi.org/format/1.1/#fetching-sorting)","schema":{"type":"array","items":{"type":"string"}},"explode":false,"example":["id","displayName","-description"]},{"name":"page[number]","in":"query","required":false,"description":"The pagination offset. See also [JSON:API Specification - Pagination](https://jsonapi.org/format/1.1/#fetching-pagination) and [JSON:API Specification - Query Parameter Families](https://jsonapi.org/format/1.1/#query-parameters-families)","schema":{"type":"integer","example":1}},{"name":"page[size]","in":"query","required":false,"description":"The pagination limit. See also [JSON:API Specification - Pagination](https://jsonapi.org/format/1.1/#fetching-pagination) and [JSON:API Specification - Query Parameter Families](https://jsonapi.org/format/1.1/#query-parameters-families)","schema":{"type":"integer","example":100}}],"responses":{"200":{"description":"List groups (if pagination is not specified, the first page with 25 elements is returned)","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["links","data"],"properties":{"jsonapi":{"$ref":"#/components/schemas/jsonapi"},"meta":{"$ref":"#/components/schemas/metaWithTotalNumber"},"links":{"$ref":"#/components/schemas/GroupLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GroupDataWithRelationships"}},"included":{"$ref":"#/components/schemas/GroupToInclude"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"}}},"post":{"tags":["groups"],"summary":"Create a group","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"requestBody":{"description":"The JSON:API representation of the group to create","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/GroupData"}}}}}},"responses":{"201":{"description":"The group with the given name was created","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["links","data"],"properties":{"jsonapi":{"$ref":"#/components/schemas/jsonapi"},"meta":{"$ref":"#/components/schemas/meta"},"links":{"$ref":"#/components/schemas/GroupLinks"},"data":{"$ref":"#/components/schemas/GroupDataWithEmptyRelationships"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"409":{"$ref":"#/components/responses/ConflictError"}}}},"/AuthenticationAndAuthorization/api/v1/groups/{name}":{"parameters":[{"name":"name","in":"path","required":true,"description":"Name of the group (unique)","schema":{"type":"string","example":"developers"}}],"get":{"tags":["groups"],"summary":"Get the details about a single group","security":[{"BasicAuth":[]},{"OAuth2":["ANA_USER","ANA_ADMIN"]}],"parameters":[{"name":"include","in":"query","required":false,"description":"Related objects to include. See also [JSON:API Specification - Includes](https://jsonapi.org/format/1.1/#fetching-includes)","schema":{"type":"array","items":{"type":"string"}},"explode":false,"example":["users","groups","roles"]}],"responses":{"200":{"description":"The group was successfully read","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["links","data"],"properties":{"jsonapi":{"$ref":"#/components/schemas/jsonapi"},"meta":{"$ref":"#/components/schemas/meta"},"links":{"$ref":"#/components/schemas/GroupLinks"},"data":{"$ref":"#/components/schemas/GroupDataWithRelationships"},"included":{"$ref":"#/components/schemas/GroupToInclude"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"}}},"delete":{"tags":["groups"],"summary":"Delete a group","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"responses":{"200":{"description":"The group with the given name was deleted","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["links","data"],"properties":{"jsonapi":{"$ref":"#/components/schemas/jsonapi"},"meta":{"$ref":"#/components/schemas/meta"},"data":{"$ref":"#/components/schemas/GroupData"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundError"}}},"put":{"tags":["groups"],"summary":"Replace a group","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"parameters":[{"name":"include","in":"query","required":false,"description":"Related objects to include. See also [JSON:API Specification - Includes](https://jsonapi.org/format/1.1/#fetching-includes)","schema":{"type":"array","items":{"type":"string"}},"explode":false,"example":["users","groups","roles"]}],"requestBody":{"description":"The JSON:API representation of the group to replace","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/GroupDataWithoutId"}}}}}},"responses":{"200":{"description":"The group with the given name was replaced","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["links","data"],"properties":{"jsonapi":{"$ref":"#/components/schemas/jsonapi"},"meta":{"$ref":"#/components/schemas/meta"},"links":{"$ref":"#/components/schemas/GroupLinks"},"data":{"$ref":"#/components/schemas/GroupDataWithRelationships"},"included":{"$ref":"#/components/schemas/GroupToInclude"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundError"}}},"patch":{"tags":["groups"],"summary":"Modify specific properties of a group","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"parameters":[{"name":"include","in":"query","required":false,"description":"Related objects to include. See also [JSON:API Specification - Includes](https://jsonapi.org/format/1.1/#fetching-includes)","schema":{"type":"array","items":{"type":"string"}},"explode":false,"example":["users","groups","roles"]}],"requestBody":{"description":"The JSON representation of the group, containing only the attributes to be updated","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/GroupDataWithoutId"}}}}}},"responses":{"200":{"description":"The group attributes were updated","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"jsonapi":{"$ref":"#/components/schemas/jsonapi"},"meta":{"$ref":"#/components/schemas/meta"},"links":{"$ref":"#/components/schemas/GroupLinks"},"data":{"$ref":"#/components/schemas/GroupDataWithRelationships"},"included":{"$ref":"#/components/schemas/GroupToInclude"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundError"}}}},"/AuthenticationAndAuthorization/api/v1/groups/{groupName}/relationships/users":{"parameters":[{"name":"groupName","in":"path","required":true,"description":"Name of the group (unique)","schema":{"type":"string","example":"developers"}}],"get":{"tags":["groups-relationships"],"summary":"List all group-user relationships","security":[{"BasicAuth":[]},{"OAuth2":["ANA_USER","ANA_ADMIN"]}],"responses":{"200":{"description":"List all group-user relationships for the specified group","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/GroupUserRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/userResourceObjectIdentifier"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"}}},"delete":{"tags":["groups-relationships"],"summary":"Delete group-user relationships for the specified group","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"requestBody":{"description":"The JSON:API representation of the group-user relationships to delete","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/userResourceObjectIdentifier"}}}}}}},"responses":{"200":{"description":"Deleted group-user relationships for the specified group","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/GroupUserRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/userResourceObjectIdentifier"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"}}},"post":{"tags":["groups-relationships"],"summary":"Add group-user relationships","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"requestBody":{"description":"The JSON:API representation of the group-user relationships to add","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/userResourceObjectIdentifier"}}}}}}},"responses":{"200":{"description":"The group-user relationships for the specified group","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/GroupUserRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/userResourceObjectIdentifier"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"},"409":{"$ref":"#/components/responses/ConflictError"}}},"patch":{"tags":["groups-relationships"],"summary":"Replace group-user relationships","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"requestBody":{"description":"The JSON:API representation of the group-user relationships","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/userResourceObjectIdentifier"}}}}}}},"responses":{"200":{"description":"The updated group-user relationships for the specified group","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/GroupUserRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/userResourceObjectIdentifier"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"}}}},"/AuthenticationAndAuthorization/api/v1/groups/{groupName}/relationships/groups":{"parameters":[{"name":"groupName","in":"path","required":true,"description":"Name of the group (unique)","schema":{"type":"string","example":"developers"}}],"get":{"tags":["groups-relationships"],"summary":"List all group-subgroup relationships","security":[{"BasicAuth":[]},{"OAuth2":["ANA_USER","ANA_ADMIN"]}],"responses":{"200":{"description":"List all group-subgroup relationships for the specified group","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/GroupGroupRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/subgroupResourceObjectIdentifier"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"}}},"delete":{"tags":["groups-relationships"],"summary":"Delete group-subgroup relationships for the specified group","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"responses":{"200":{"description":"The group-subgroup relationships for the specified group","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/GroupGroupRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/subgroupResourceObjectIdentifier"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"}}},"post":{"tags":["groups-relationships"],"summary":"Add group-subgroup relationships","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"requestBody":{"description":"The JSON:API representation of the group-subgroup relationships to add","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/subgroupResourceObjectIdentifier"}}}}}}},"responses":{"200":{"description":"The group-subgroup relationships for the specified group","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/GroupGroupRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/subgroupResourceObjectIdentifier"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"},"409":{"$ref":"#/components/responses/ConflictError"}}},"patch":{"tags":["groups-relationships"],"summary":"Replace group-subgroup relationships","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"requestBody":{"description":"The JSON:API representation of the group-subgroup relationships","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/subgroupResourceObjectIdentifier"}}}}}}},"responses":{"200":{"description":"The group-subgroup relationships for the specified group","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/GroupGroupRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/subgroupResourceObjectIdentifier"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"}}}},"/AuthenticationAndAuthorization/api/v1/groups/{groupName}/relationships/roles":{"parameters":[{"name":"groupName","in":"path","required":true,"description":"Name of the group (unique)","schema":{"type":"string","example":"developers"}}],"get":{"tags":["groups-relationships"],"summary":"List all group-role relationships","security":[{"BasicAuth":[]},{"OAuth2":["ANA_USER","ANA_ADMIN"]}],"responses":{"200":{"description":"List all group-role relationships for the specified group","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/GroupRoleRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/roleResourceObjectIdentifier"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"}}},"delete":{"tags":["groups-relationships"],"summary":"Delete group-role relationships for the specified group","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"requestBody":{"description":"The JSON:API representation of the group-role relationships to delete","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/roleResourceObjectIdentifier"}}}}}}},"responses":{"200":{"description":"Rhe group-role relationships for the specified group","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/GroupRoleRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/roleResourceObjectIdentifier"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"}}},"post":{"tags":["groups-relationships"],"summary":"Add group-role relationships","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"requestBody":{"description":"The JSON:API representation of the group-role relationships to add","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/roleResourceObjectIdentifier"}}}}}}},"responses":{"200":{"description":"The group-role relationships for the specified group","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/GroupRoleRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/roleResourceObjectIdentifier"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"},"409":{"$ref":"#/components/responses/ConflictError"}}},"patch":{"tags":["groups-relationships"],"summary":"Replace group-role relationships","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"requestBody":{"description":"The JSON:API representation of the group-role relationships","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/roleResourceObjectIdentifier"}}}}}}},"responses":{"200":{"description":"The updated group-role relationships for the specified group","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/GroupRoleRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/roleResourceObjectIdentifier"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"}}}},"/AuthenticationAndAuthorization/api/v1/roles":{"get":{"tags":["roles"],"summary":"List roles","security":[{"BasicAuth":[]},{"OAuth2":["ANA_USER","ANA_ADMIN"]}],"parameters":[{"name":"include","in":"query","required":false,"description":"Related objects to include. Only used for application/vnd.api+json response type. See also [JSON:API Specification - Includes](https://jsonapi.org/format/1.1/#fetching-includes)","schema":{"type":"array","items":{"type":"string"}},"explode":false,"example":["users","groups","permissions"]},{"name":"sort","in":"query","required":false,"description":"The sort criteria for the returned data, as a comma-separated list. For descending order, the criteria must be preceded by a minus sign (\"-\"). Only used for application/vnd.api+json response type. See also [JSON:API Specification - Sorting](https://jsonapi.org/format/1.1/#fetching-sorting)","schema":{"type":"array","items":{"type":"string"}},"explode":false,"example":["id","description"]},{"name":"page[number]","in":"query","required":false,"description":"The pagination offset. Only used for application/vnd.api+json response type. See also [JSON:API Specification - Pagination](https://jsonapi.org/format/1.1/#fetching-pagination) and [JSON:API Specification - Query Parameter Families](https://jsonapi.org/format/1.1/#query-parameters-families)","schema":{"type":"integer","example":1}},{"name":"page[size]","in":"query","required":false,"description":"The pagination limit. Only used for application/vnd.api+json response type. See also [JSON:API Specification - Pagination](https://jsonapi.org/format/1.1/#fetching-pagination) and [JSON:API Specification - Query Parameter Families](https://jsonapi.org/format/1.1/#query-parameters-families)","schema":{"type":"integer","example":100}}],"responses":{"200":{"description":"List all roles","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["links","data"],"properties":{"jsonapi":{"$ref":"#/components/schemas/jsonapi"},"meta":{"$ref":"#/components/schemas/metaWithTotalNumber"},"links":{"$ref":"#/components/schemas/RoleLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/RoleDataWithRelationships"}},"included":{"$ref":"#/components/schemas/RoleToInclude"}}}},"application/xml":{"schema":{"$ref":"#/components/schemas/RoleManagement"}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"}}},"post":{"tags":["roles"],"summary":"Create a role","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"requestBody":{"description":"The JSON:API representation of the role to create","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/RoleData"}}}}}},"responses":{"201":{"description":"The role with the given name was created","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["links","data"],"properties":{"jsonapi":{"$ref":"#/components/schemas/jsonapi"},"meta":{"$ref":"#/components/schemas/meta"},"links":{"$ref":"#/components/schemas/RoleLinks"},"data":{"$ref":"#/components/schemas/RoleDataWithEmptyRelationships"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"409":{"$ref":"#/components/responses/ConflictError"}}},"patch":{"tags":["roles"],"summary":"Import xml containing roles, role-user and role-group relationships","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"parameters":[{"name":"overwrite","in":"query","required":false,"description":"In case some roles already exist in the database, overwrite them. The default is false, which means it is not allowed to import roles that are already in the database and an error message will be returned.","schema":{"type":"boolean","default":false}}],"requestBody":{"description":"The xml to be imported. The xml must have the same structure as the one that can be found in the installation inside configuration folder (roles.xml). Multiple Role elements can be included. In each Role element, multiple RoleMember elements can be included. For RoleMember elements, we have just two types: user and group","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/RoleManagement"}}}},"responses":{"200":{"description":"The xml was successfully imported"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundError"},"409":{"$ref":"#/components/responses/ConflictError"}}}},"/AuthenticationAndAuthorization/api/v1/roles/{name}":{"parameters":[{"name":"name","in":"path","required":true,"description":"Name of the role (unique)","schema":{"type":"string","example":"ANA_ADMIN"}}],"get":{"tags":["roles"],"summary":"Get the details about a role","security":[{"BasicAuth":[]},{"OAuth2":["ANA_USER","ANA_ADMIN"]}],"parameters":[{"name":"include","in":"query","required":false,"description":"Related objects to include. See also [JSON:API Specification - Includes](https://jsonapi.org/format/1.1/#fetching-includes)","schema":{"type":"array","items":{"type":"string"}},"explode":false,"example":["users","groups","permissions"]}],"responses":{"200":{"description":"The role was successfully read","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["links","data"],"properties":{"jsonapi":{"$ref":"#/components/schemas/jsonapi"},"meta":{"$ref":"#/components/schemas/meta"},"links":{"$ref":"#/components/schemas/RoleLinks"},"data":{"$ref":"#/components/schemas/RoleDataWithRelationships"},"included":{"$ref":"#/components/schemas/RoleToInclude"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"}}},"delete":{"tags":["roles"],"summary":"Delete a role","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"responses":{"200":{"description":"The role with the given name was deleted","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["links","data"],"properties":{"jsonapi":{"$ref":"#/components/schemas/jsonapi"},"meta":{"$ref":"#/components/schemas/meta"},"data":{"$ref":"#/components/schemas/RoleData"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundError"}}},"put":{"tags":["roles"],"summary":"Replace a role","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"parameters":[{"name":"include","in":"query","required":false,"description":"Related objects to include. See also [JSON:API Specification - Includes](https://jsonapi.org/format/1.1/#fetching-includes)","schema":{"type":"array","items":{"type":"string"}},"explode":false,"example":["users","groups","permissions"]}],"requestBody":{"description":"The JSON:API representation of the role to replace","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/RoleDataWithoutId"}}}}}},"responses":{"200":{"description":"The role with the given name was replaced","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["links","data"],"properties":{"jsonapi":{"$ref":"#/components/schemas/jsonapi"},"meta":{"$ref":"#/components/schemas/meta"},"links":{"$ref":"#/components/schemas/RoleLinks"},"data":{"$ref":"#/components/schemas/RoleDataWithRelationships"},"included":{"$ref":"#/components/schemas/RoleToInclude"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundError"}}},"patch":{"tags":["roles"],"summary":"Modify specific properties of a role","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"parameters":[{"name":"include","in":"query","required":false,"description":"Related objects to include. See also [JSON:API Specification - Includes](https://jsonapi.org/format/1.1/#fetching-includes)","schema":{"type":"array","items":{"type":"string"}},"explode":false,"example":["users","groups","permissions"]}],"requestBody":{"description":"The JSON representation of the role, containing only the attributes to be updated","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/RoleDataWithoutId"}}}}}},"responses":{"200":{"description":"The role attributes were updated","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"jsonapi":{"$ref":"#/components/schemas/jsonapi"},"meta":{"$ref":"#/components/schemas/meta"},"links":{"$ref":"#/components/schemas/RoleLinks"},"data":{"$ref":"#/components/schemas/RoleDataWithRelationships"},"included":{"$ref":"#/components/schemas/RoleToInclude"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundError"}}}},"/AuthenticationAndAuthorization/api/v1/roles/{roleName}/relationships/users":{"parameters":[{"name":"roleName","in":"path","required":true,"description":"Name of the role (unique)","schema":{"type":"string","example":"POM_ADMIN"}}],"get":{"tags":["roles-relationships"],"summary":"List all role-user relationships","security":[{"BasicAuth":[]},{"OAuth2":["ANA_USER","ANA_ADMIN"]}],"responses":{"200":{"description":"List all role-user relationships for the specified role","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/RoleUserRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/userResourceObjectIdentifier"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"}}},"delete":{"tags":["roles-relationships"],"summary":"Delete role-user relationships for the specified role","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"requestBody":{"description":"The JSON:API representation of the role-user relationships","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/userResourceObjectIdentifier"}}}}}}},"responses":{"200":{"description":"The role-user relationships for the specified role","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/RoleUserRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/userResourceObjectIdentifier"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"}}},"post":{"tags":["roles-relationships"],"summary":"Add role-user relationships","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"requestBody":{"description":"The JSON:API representation of the role-user relationships to add","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/userResourceObjectIdentifier"}}}}}}},"responses":{"200":{"description":"The role-user relationships for the specified role","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/RoleUserRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/userResourceObjectIdentifier"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"},"409":{"$ref":"#/components/responses/ConflictError"}}},"patch":{"tags":["roles-relationships"],"summary":"Replace role-user relationships","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"requestBody":{"description":"The JSON:API representation of the role-user relationships","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/userResourceObjectIdentifier"}}}}}}},"responses":{"200":{"description":"The updated role-user relationships for the specified role","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/RoleUserRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/userResourceObjectIdentifier"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"}}}},"/AuthenticationAndAuthorization/api/v1/roles/{roleName}/relationships/groups":{"parameters":[{"name":"roleName","in":"path","required":true,"description":"Name of the role (unique)","schema":{"type":"string","example":"POM_ADMIN"}}],"get":{"tags":["roles-relationships"],"summary":"List all role-group relationships","security":[{"BasicAuth":[]},{"OAuth2":["ANA_USER","ANA_ADMIN"]}],"responses":{"200":{"description":"List all role-group relationships for the specified role","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/RoleGroupRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/groupResourceObjectIdentifier"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"}}},"delete":{"tags":["roles-relationships"],"summary":"Delete role-group relationships for the specified role","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"requestBody":{"description":"The JSON:API representation of the role-group relationships to delete","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/groupResourceObjectIdentifier"}}}}}}},"responses":{"200":{"description":"The role-group relationships for the specified role","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/RoleGroupRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/groupResourceObjectIdentifier"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"}}},"post":{"tags":["roles-relationships"],"summary":"Add role-group relationships","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"requestBody":{"description":"The JSON:API representation of the role-group relationships to add","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/groupResourceObjectIdentifier"}}}}}}},"responses":{"200":{"description":"The role-group relationships for the specified role","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/RoleGroupRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/groupResourceObjectIdentifier"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"},"409":{"$ref":"#/components/responses/ConflictError"}}},"patch":{"tags":["roles-relationships"],"summary":"Replace role-group relationships","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"requestBody":{"description":"The JSON:API representation of the role-group relationships","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/groupResourceObjectIdentifier"}}}}}}},"responses":{"200":{"description":"The role-group relationships for the specified role","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/RoleGroupRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/groupResourceObjectIdentifier"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"}}}},"/AuthenticationAndAuthorization/api/v1/roles/{roleName}/relationships/permissions":{"parameters":[{"name":"roleName","in":"path","required":true,"description":"Name of the role (unique)","schema":{"type":"string","example":"POM_ADMIN"}}],"get":{"tags":["roles-relationships"],"summary":"List all role-permission relationships","security":[{"BasicAuth":[]},{"OAuth2":["ANA_USER","ANA_ADMIN"]}],"parameters":[{"name":"env","in":"query","required":false,"description":"Environment for the role-permission   relationship(s). When absent, the mappings for all environments will be listed.","schema":{"type":"string","example":"compart"}}],"responses":{"200":{"description":"List all role-permission relationships for the specified role","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/RolePermissionRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/permissionWithMetaResourceObjectIdentifier"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"}}},"delete":{"tags":["roles-relationships"],"summary":"Delete role-permission relationships for the specified role","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"parameters":[{"name":"env","in":"query","required":false,"description":"Environment for the role-permission   relationship(s). When absent, the default is 'compart'.","schema":{"type":"string","example":"compart"}}],"requestBody":{"description":"The JSON:API representation of the role-permission relationships to delete","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/permissionResourceObjectIdentifier"}}}}}}},"responses":{"200":{"description":"The role-permission relationships for the specified role","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/RolePermissionRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/permissionWithMetaResourceObjectIdentifier"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"}}},"post":{"tags":["roles-relationships"],"summary":"Add role-permission relationships","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"parameters":[{"name":"env","in":"query","required":false,"description":"Environment for the role-permission   relationship(s). When absent, the default is 'compart'.","schema":{"type":"string","example":"compart"}}],"requestBody":{"description":"The JSON:API representation of the role-permission relationships to add","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/permissionResourceObjectIdentifier"}}}}}}},"responses":{"200":{"description":"The role-permission relationships for the specified role","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/RolePermissionRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/permissionWithMetaResourceObjectIdentifier"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"},"409":{"$ref":"#/components/responses/ConflictError"}}},"patch":{"tags":["roles-relationships"],"summary":"Replace role-permission relationships","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"parameters":[{"name":"env","in":"query","required":false,"description":"Environment for the role-permission   relationship(s). When absent, the default is 'compart'.","schema":{"type":"string","example":"compart"}}],"requestBody":{"description":"The JSON:API representation of the role-permission relationships","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/permissionResourceObjectIdentifier"}}}}}}},"responses":{"200":{"description":"The updated role-permission relationships for the specified role","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/RolePermissionRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/permissionWithMetaResourceObjectIdentifier"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"}}}},"/AuthenticationAndAuthorization/api/v1/permissions":{"get":{"tags":["permissions"],"summary":"List permissions","security":[{"BasicAuth":[]},{"OAuth2":["ANA_USER","ANA_ADMIN"]}],"parameters":[{"name":"include","in":"query","required":false,"description":"Related objects to include. Only used for application/vnd.api+json response type. See also [JSON:API Specification - Includes](https://jsonapi.org/format/1.1/#fetching-includes)","schema":{"type":"array","items":{"type":"string"}},"explode":false,"example":["roles"]},{"name":"sort","in":"query","required":false,"description":"The sort criteria for the returned data, as a comma-separated list. For descending order, the criteria must be preceded by a minus sign (\"-\"). Only used for application/vnd.api+json response type. See also [JSON:API Specification - Sorting](https://jsonapi.org/format/1.1/#fetching-sorting)","schema":{"type":"array","items":{"type":"string"}},"explode":false,"example":["id","-description"]},{"name":"page[number]","in":"query","required":false,"description":"The pagination offset. Only used for application/vnd.api+json response type. See also [JSON:API Specification - Pagination](https://jsonapi.org/format/1.1/#fetching-pagination) and [JSON:API Specification - Query Parameter Families](https://jsonapi.org/format/1.1/#query-parameters-families)","schema":{"type":"integer","example":1}},{"name":"page[size]","in":"query","required":false,"description":"The pagination limit. Only used for application/vnd.api+json response type. See also [JSON:API Specification - Pagination](https://jsonapi.org/format/1.1/#fetching-pagination) and [JSON:API Specification - Query Parameter Families](https://jsonapi.org/format/1.1/#query-parameters-families)","schema":{"type":"integer","example":100}},{"name":"env","in":"query","required":false,"description":"The environment for which the permissions will be returned. Only the permissions that have relationships to the roles in the authentication object for this specific environment will be listed. When this parameter is used, all the other parameters are ignored, no pagination nor filtering will be done. The returned list of permissions will contain no relationships and no includes.","schema":{"type":"string","example":"compart"}}],"responses":{"200":{"description":"List all permissions. When the 'env' parameter is used in the request, only the permissions matching the environment and the roles in the authentication will be listed (and no includes nor relationships will be present)","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["links","data"],"properties":{"jsonapi":{"$ref":"#/components/schemas/jsonapi"},"meta":{"$ref":"#/components/schemas/metaWithTotalNumber"},"links":{"$ref":"#/components/schemas/PermissionLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PermissionDataWithRelationships"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/PermissionToInclude"}}}}},"application/xml":{"schema":{"$ref":"#/components/schemas/PermissionManagement"}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"}}},"post":{"tags":["permissions"],"summary":"Create a permission","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"requestBody":{"description":"The JSON:API representation of the permission to create","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PermissionData"}}}}}},"responses":{"201":{"description":"The permission with the given name was created","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["links","data"],"properties":{"jsonapi":{"$ref":"#/components/schemas/jsonapi"},"meta":{"$ref":"#/components/schemas/meta"},"links":{"$ref":"#/components/schemas/PermissionLinks"},"data":{"$ref":"#/components/schemas/PermissionDataWithEmptyRelationships"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"409":{"$ref":"#/components/responses/ConflictError"}}},"patch":{"tags":["permissions"],"summary":"Import xml containing permissions and permission-role relationships","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN","SCOPE_XML"]}],"parameters":[{"name":"overwrite","in":"query","required":false,"description":"In case some permissions already exist in the database, overwrite them. The default is false, which means it is not allowed to import permissions that are already in the database and an error message will be returned.","schema":{"type":"boolean","default":false}}],"requestBody":{"description":"The xml to be imported. Multiple Permission elements can be included. Also, multiple PermissionMapping elements can be included. The PermissionMapping has an optional attribute env that instructs A&A to create the mapping for a specific environment. When absent, the default env is \"compart\"","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/PermissionManagement"}}}},"responses":{"200":{"description":"The xml was successfully imported"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundError"},"409":{"$ref":"#/components/responses/ConflictError"}}}},"/AuthenticationAndAuthorization/api/v1/permissions/{name}":{"parameters":[{"name":"name","in":"path","required":true,"description":"Name of the permission (unique)","schema":{"type":"string","example":"TENANT_LIST"}}],"get":{"tags":["permissions"],"summary":"Get the details about a permission","security":[{"BasicAuth":[]},{"OAuth2":["ANA_USER","ANA_ADMIN"]}],"parameters":[{"name":"include","in":"query","required":false,"description":"Related objects to include. See also [JSON:API Specification - Includes](https://jsonapi.org/format/1.1/#fetching-includes)","schema":{"type":"array","items":{"type":"string"}},"explode":false,"example":["roles"]}],"responses":{"200":{"description":"The permission was successfully read","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["links","data"],"properties":{"jsonapi":{"$ref":"#/components/schemas/jsonapi"},"meta":{"$ref":"#/components/schemas/meta"},"links":{"$ref":"#/components/schemas/PermissionLinks"},"data":{"$ref":"#/components/schemas/PermissionDataWithRelationships"},"included":{"$ref":"#/components/schemas/PermissionToInclude"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"}}},"delete":{"tags":["permissions"],"summary":"Delete a permission","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"responses":{"200":{"description":"The permission with the given name was deleted","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["links","data"],"properties":{"jsonapi":{"$ref":"#/components/schemas/jsonapi"},"meta":{"$ref":"#/components/schemas/meta"},"data":{"$ref":"#/components/schemas/PermissionData"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundError"}}},"put":{"tags":["permissions"],"summary":"Replace a permission","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"parameters":[{"name":"include","in":"query","required":false,"description":"Related objects to include. See also [JSON:API Specification - Includes](https://jsonapi.org/format/1.1/#fetching-includes)","schema":{"type":"array","items":{"type":"string"}},"explode":false,"example":["roles"]}],"requestBody":{"description":"The JSON:API representation of the permission to replace","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PermissionDataWithoutId"}}}}}},"responses":{"200":{"description":"The permission with the given name was replaced","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["links","data"],"properties":{"jsonapi":{"$ref":"#/components/schemas/jsonapi"},"meta":{"$ref":"#/components/schemas/meta"},"links":{"$ref":"#/components/schemas/PermissionLinks"},"data":{"$ref":"#/components/schemas/PermissionDataWithRelationships"},"included":{"$ref":"#/components/schemas/PermissionToInclude"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundError"}}},"patch":{"tags":["permissions"],"summary":"Modify specific properties of a permission","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"parameters":[{"name":"include","in":"query","required":false,"description":"Related objects to include. See also [JSON:API Specification - Includes](https://jsonapi.org/format/1.1/#fetching-includes)","schema":{"type":"array","items":{"type":"string"}},"explode":false,"example":["roles"]}],"requestBody":{"description":"The JSON representation of the permission, containing only the attributes to be updated","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PermissionDataWithoutId"}}}}}},"responses":{"200":{"description":"The permission attributes were updated","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"jsonapi":{"$ref":"#/components/schemas/jsonapi"},"meta":{"$ref":"#/components/schemas/meta"},"links":{"$ref":"#/components/schemas/PermissionLinks"},"data":{"$ref":"#/components/schemas/PermissionDataWithRelationships"},"included":{"$ref":"#/components/schemas/PermissionToInclude"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundError"}}}},"/AuthenticationAndAuthorization/api/v1/permissions/{permissionName}/relationships/roles":{"parameters":[{"name":"permissionName","in":"path","required":true,"description":"Name of the permission (unique)","schema":{"type":"string","example":"TENANT_LIST"}}],"get":{"tags":["permissions-relationships"],"summary":"List all permission-role relationships","security":[{"BasicAuth":[]},{"OAuth2":["ANA_USER","ANA_ADMIN"]}],"parameters":[{"name":"env","in":"query","required":false,"description":"Environment for the permission-role   relationship(s). When absent, the mappings for all environments will be listed.","schema":{"type":"string","example":"compart"}}],"responses":{"200":{"description":"List all permission-role relationships for the specified permission","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/PermissionRoleRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/roleWithMetaResourceObjectIdentifier"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"}}},"delete":{"tags":["permissions-relationships"],"summary":"Delete permission-role relationships for the specified permission","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"parameters":[{"name":"env","in":"query","required":false,"description":"Environment for the permission-role   relationship(s). When absent, the default is 'compart'.","schema":{"type":"string","example":"compart"}}],"requestBody":{"description":"The JSON:API representation of the permission-role relationships to delete","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/roleResourceObjectIdentifier"}}}}}}},"responses":{"200":{"description":"The permission-role relationships for the specified permission","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/PermissionRoleRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/roleWithMetaResourceObjectIdentifier"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"}}},"post":{"tags":["permissions-relationships"],"summary":"Add permission-role relationships","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"parameters":[{"name":"env","in":"query","required":false,"description":"Environment for the permission-role   relationship(s). When absent, the default is 'compart'.","schema":{"type":"string","example":"compart"}}],"requestBody":{"description":"The JSON:API representation of the permission-role relationships to add","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/roleResourceObjectIdentifier"}}}}}}},"responses":{"200":{"description":"The permission-role relationships for the specified permission","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/PermissionRoleRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/roleWithMetaResourceObjectIdentifier"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"},"409":{"$ref":"#/components/responses/ConflictError"}}},"patch":{"tags":["permissions-relationships"],"summary":"Replace permission-role relationships","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"parameters":[{"name":"env","in":"query","required":false,"description":"Environment for the permission-role   relationship(s). When absent, the default is 'compart'.","schema":{"type":"string","example":"compart"}}],"requestBody":{"description":"The JSON:API representation of the permission-role relationships","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/roleResourceObjectIdentifier"}}}}}}},"responses":{"200":{"description":"The permission-role relationships for the specified permission","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/PermissionRoleRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/roleWithMetaResourceObjectIdentifier"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"404":{"$ref":"#/components/responses/NotFoundError"}}}},"/AuthenticationAndAuthorization/api/v1/info":{"get":{"tags":["info"],"summary":"List the management configuration details","security":[{"BasicAuth":[]},{"OAuth2":["ANA_USER","ANA_ADMIN"]}],"responses":{"200":{"description":"The info was successfully read. In the attributes section, there is the \"externalIdentityManagement\" flag - if true, the users can come also from external sources (LDAP/AD); if false, they are managed only in the internal database of A&A. The info section will be returned in response only for authenticated users.","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["links","data"],"properties":{"jsonapi":{"$ref":"#/components/schemas/jsonapi"},"meta":{"$ref":"#/components/schemas/meta"},"links":{"$ref":"#/components/schemas/InfoLinks"},"data":{"$ref":"#/components/schemas/InfoData"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"}}}},"/AuthenticationAndAuthorization/api/v1/identities":{"get":{"tags":["users"],"summary":"Export xml containing users, groups, user-group and group-subgroup relationships","security":[{"BasicAuth":[]},{"OAuth2":["ANA_USER","ANA_ADMIN"]}],"responses":{"200":{"description":"The xml was successfully exported. The xml has the same structure as the one that can be found in the installation inside config folder. It contains the users and groups present in the internal A&A database.","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/Authentication"}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"}}},"patch":{"tags":["users"],"summary":"Import xml containing users, groups, user-group and group-subgroup relationships","security":[{"BasicAuth":[]},{"OAuth2":["ANA_ADMIN"]}],"parameters":[{"name":"overwrite","in":"query","required":false,"description":"In case some users or groups already exist in the database, overwrite them. The default is false, which means it is not allowed to import users that are already in the database and an error message will be returned.","schema":{"type":"boolean","default":false}},{"name":"passwordsHashed","in":"query","required":false,"description":"Specifies if the passwords for the users are already hashed in the xml or if they are plaintext. The default value is true.","schema":{"type":"boolean","default":true}}],"requestBody":{"description":"The xml binary to be imported. The xml must have the same structure as the one that can be found in the installation inside config folder.","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/Authentication"}}}},"responses":{"200":{"description":"The xml was successfully imported"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundError"},"409":{"$ref":"#/components/responses/ConflictError"}}}}},"components":{"responses":{"BadRequest":{"description":"The given input is invalid (for example when the password does not meet rules)"},"UnauthorizedError":{"description":"The given username/password pair does not exist"},"ForbiddenError":{"description":"The given user is not allowed to execute the operation"},"NotFoundError":{"description":"The resource with the given id/name does not exist"},"ConflictError":{"description":"The resource already exists"}},"schemas":{"jsonapi":{"type":"object","properties":{"version":{"type":"string","example":"1.1"}}},"metaWithTotalNumber":{"type":"object","properties":{"build":{"type":"string","example":"20190311-120506 #CUSTOM_LOCAL_BUILD built by lio"},"api":{"type":"string","example":"v1"},"version":{"type":"string","example":"1.7.2"},"totalNumberOfItems":{"type":"string","example":"1"}}},"meta":{"type":"object","properties":{"versionAndBuild":{"type":"string","example":"1.7.2"},"api":{"type":"string","example":"v1"}}},"InfoLinks":{"type":"object","required":["self"],"properties":{"self":{"type":"string","example":"/info"}}},"InfoData":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","enum":["info"]},"attributes":{"$ref":"#/components/schemas/InfoAttributes"}}},"InfoAttributes":{"type":"object","properties":{"externalIdentityManagement":{"type":"boolean","example":false}}},"UserLinks":{"type":"object","required":["self"],"properties":{"self":{"type":"string","example":"/users/john"}}},"UserData":{"type":"object","required":["type","id","attributes"],"properties":{"type":{"type":"string","enum":["users"]},"id":{"type":"string","example":"john"},"attributes":{"$ref":"#/components/schemas/UserAttributes"}}},"UserDataWithoutPassword":{"type":"object","required":["type","id","attributes"],"properties":{"type":{"type":"string","enum":["users"]},"id":{"type":"string","example":"john"},"attributes":{"$ref":"#/components/schemas/UserAttributesWithoutPassword"}}},"UserDataWithoutId":{"type":"object","required":["attributes"],"properties":{"attributes":{"$ref":"#/components/schemas/UserAttributes"}}},"UserDataWithEmptyRelationships":{"type":"object","required":["type","id","attributes"],"properties":{"type":{"type":"string","enum":["users"]},"id":{"type":"string","example":"john"},"attributes":{"$ref":"#/components/schemas/UserAttributesWithoutPassword"},"relationships":{"$ref":"#/components/schemas/UserEmptyRelationships"}}},"UserDataWithRelationships":{"type":"object","required":["type","id","attributes"],"properties":{"type":{"type":"string","enum":["users"]},"id":{"type":"string","example":"john"},"attributes":{"$ref":"#/components/schemas/UserAttributesWithoutPassword"},"relationships":{"$ref":"#/components/schemas/UserRelationships"}}},"UserAttributes":{"type":"object","properties":{"password":{"type":"string","example":"strong_password"},"displayName":{"type":"string","example":"Test Testinger"},"organization":{"type":"string","example":"Development"},"location":{"type":"string","example":"Third Floor"},"telephone":{"type":"string","example":"123"},"email":{"type":"string","example":"test.testinger@compart.com"}}},"UserAttributesWithoutPassword":{"type":"object","properties":{"displayName":{"type":"string","example":"Test Testinger"},"organization":{"type":"string","example":"Development"},"location":{"type":"string","example":"Third Floor"},"telephone":{"type":"string","example":"123"},"email":{"type":"string","example":"test.testinger@compart.com"}}},"UserEmptyRelationships":{"type":"object","properties":{"groups":{"$ref":"#/components/schemas/userGroupsEmptyRelationship"},"roles":{"$ref":"#/components/schemas/userRolesEmptyRelationship"}}},"UserRelationships":{"type":"object","properties":{"groups":{"$ref":"#/components/schemas/userGroupsRelationship"},"roles":{"$ref":"#/components/schemas/userRolesRelationship"}}},"GroupLinks":{"type":"object","required":["self"],"properties":{"self":{"type":"string","example":"/groups/developers"}}},"GroupData":{"type":"object","required":["type","id","attributes"],"properties":{"type":{"type":"string","enum":["groups"]},"id":{"type":"string","example":"developers"},"attributes":{"$ref":"#/components/schemas/GroupAttributes"}}},"GroupDataWithoutId":{"type":"object","required":["attributes"],"properties":{"attributes":{"$ref":"#/components/schemas/GroupAttributes"}}},"GroupDataWithEmptyRelationships":{"type":"object","required":["type","id","attributes"],"properties":{"type":{"type":"string","enum":["groups"]},"id":{"type":"string","example":"developers"},"attributes":{"$ref":"#/components/schemas/GroupAttributes"},"relationships":{"$ref":"#/components/schemas/GroupEmptyRelationships"}}},"GroupDataWithRelationships":{"type":"object","required":["type","id","attributes"],"properties":{"type":{"type":"string","enum":["groups"]},"id":{"type":"string","example":"developers"},"attributes":{"$ref":"#/components/schemas/GroupAttributes"},"relationships":{"$ref":"#/components/schemas/GroupRelationships"}}},"GroupAttributes":{"type":"object","properties":{"displayName":{"type":"string","example":"Development Group"},"description":{"type":"string","example":"Members of Development"}}},"GroupEmptyRelationships":{"type":"object","properties":{"users":{"$ref":"#/components/schemas/groupUsersEmptyRelationship"},"groups":{"$ref":"#/components/schemas/groupGroupsEmptyRelationship"},"roles":{"$ref":"#/components/schemas/groupRolesEmptyRelationship"}}},"GroupRelationships":{"type":"object","properties":{"users":{"$ref":"#/components/schemas/groupUsersRelationship"},"groups":{"$ref":"#/components/schemas/groupGroupsRelationship"},"roles":{"$ref":"#/components/schemas/groupRolesRelationship"}}},"RoleLinks":{"type":"object","required":["self"],"properties":{"self":{"type":"string","example":"/roles/POM_ADMIN"}}},"RoleData":{"type":"object","required":["type","id","attributes"],"properties":{"type":{"type":"string","enum":["roles"]},"id":{"type":"string","example":"POM_ADMIN"},"attributes":{"$ref":"#/components/schemas/RoleAttributes"}}},"RoleDataWithoutId":{"type":"object","required":["attributes"],"properties":{"attributes":{"$ref":"#/components/schemas/RoleAttributes"}}},"RoleDataWithEmptyRelationships":{"type":"object","required":["type","id","attributes"],"properties":{"type":{"type":"string","enum":["roles"]},"id":{"type":"string","example":"POM_ADMIN"},"attributes":{"$ref":"#/components/schemas/RoleAttributes"},"relationships":{"$ref":"#/components/schemas/RoleEmptyRelationships"}}},"RoleEmptyRelationships":{"type":"object","properties":{"users":{"$ref":"#/components/schemas/roleUsersEmptyRelationship"},"groups":{"$ref":"#/components/schemas/roleGroupsEmptyRelationship"},"permissions":{"$ref":"#/components/schemas/rolePermissionsEmptyRelationship"}}},"RoleDataWithRelationships":{"type":"object","required":["type","id","attributes"],"properties":{"type":{"type":"string","enum":["roles"]},"id":{"type":"string","example":"POM_ADMIN"},"attributes":{"$ref":"#/components/schemas/RoleAttributes"},"relationships":{"$ref":"#/components/schemas/RoleRelationships"}}},"RoleRelationships":{"type":"object","properties":{"users":{"$ref":"#/components/schemas/roleUsersRelationship"},"groups":{"$ref":"#/components/schemas/roleGroupsRelationship"},"permissions":{"$ref":"#/components/schemas/rolePermissionsRelationship"}}},"RoleAttributes":{"type":"object","properties":{"description":{"type":"string","example":"Admin Role for POM component"}}},"PermissionLinks":{"type":"object","required":["self"],"properties":{"self":{"type":"string","example":"/permissions/TENANT_LIST"}}},"PermissionData":{"type":"object","required":["type","id","attributes"],"properties":{"type":{"type":"string","enum":["permissions"]},"id":{"type":"string","example":"TENANT_LIST"},"attributes":{"$ref":"#/components/schemas/PermissionAttributes"}}},"PermissionDataWithoutId":{"type":"object","required":["attributes"],"properties":{"attributes":{"$ref":"#/components/schemas/PermissionAttributes"}}},"PermissionDataWithEmptyRelationships":{"type":"object","required":["type","id","attributes"],"properties":{"type":{"type":"string","enum":["permissions"]},"id":{"type":"string","example":"TENANT_LIST"},"attributes":{"$ref":"#/components/schemas/PermissionAttributes"},"relationships":{"$ref":"#/components/schemas/PermissionEmptyRelationships"}}},"PermissionEmptyRelationships":{"type":"object","properties":{"roles":{"$ref":"#/components/schemas/permissionRolesEmptyRelationship"}}},"PermissionDataWithRelationships":{"type":"object","required":["type","id","attributes"],"properties":{"type":{"type":"string","enum":["permissions"]},"id":{"type":"string","example":"TENANT_LIST"},"attributes":{"$ref":"#/components/schemas/PermissionAttributes"},"relationships":{"$ref":"#/components/schemas/PermissionRelationships"}}},"PermissionRelationships":{"type":"object","properties":{"roles":{"$ref":"#/components/schemas/permissionRolesRelationship"}}},"PermissionAttributes":{"type":"object","properties":{"description":{"type":"string","example":"List the tenants"}}},"UserToInclude":{"type":"array","title":"userIncluded","items":{"anyOf":[{"$ref":"#/components/schemas/GroupIncluded"},{"$ref":"#/components/schemas/RoleIncluded"}]}},"GroupToInclude":{"type":"array","title":"groupIncluded","items":{"anyOf":[{"$ref":"#/components/schemas/UserIncluded"},{"$ref":"#/components/schemas/GroupIncluded"},{"$ref":"#/components/schemas/RoleIncluded"}]}},"RoleToInclude":{"type":"array","title":"roleIncluded","items":{"anyOf":[{"$ref":"#/components/schemas/UserIncluded"},{"$ref":"#/components/schemas/GroupIncluded"},{"$ref":"#/components/schemas/PermissionIncluded"}]}},"PermissionToInclude":{"type":"array","title":"permissionIncluded","items":{"anyOf":[{"$ref":"#/components/schemas/RoleWithMetaIncluded"}]}},"UserIncluded":{"type":"object","required":["links","data"],"properties":{"id":{"type":"string","example":"john"},"type":{"type":"string","enum":["users"]},"links":{"$ref":"#/components/schemas/UserLinks"},"attributes":{"$ref":"#/components/schemas/UserAttributesWithoutPassword"}}},"GroupIncluded":{"type":"object","required":["links","data"],"properties":{"id":{"type":"string","example":"developers"},"type":{"type":"string","enum":["groups"]},"links":{"$ref":"#/components/schemas/GroupLinks"},"attributes":{"$ref":"#/components/schemas/GroupAttributes"}}},"RoleIncluded":{"type":"object","required":["links","data"],"properties":{"id":{"type":"string","example":"POM_ADMIN"},"type":{"type":"string","enum":["roles"]},"links":{"$ref":"#/components/schemas/RoleLinks"},"attributes":{"$ref":"#/components/schemas/RoleAttributes"}}},"RoleWithMetaIncluded":{"type":"object","required":["links","data"],"properties":{"id":{"type":"string","example":"POM_ADMIN"},"type":{"type":"string","enum":["roles"]},"links":{"$ref":"#/components/schemas/RoleLinks"},"attributes":{"$ref":"#/components/schemas/RoleAttributes"},"meta":{"type":"object","properties":{"env":{"type":"string","example":"compart"}}}}},"PermissionIncluded":{"type":"object","required":["links","data"],"properties":{"id":{"type":"string","example":"TENANT_LIST"},"type":{"type":"string","enum":["permissions"]},"links":{"$ref":"#/components/schemas/PermissionLinks"},"attributes":{"$ref":"#/components/schemas/PermissionAttributes"},"meta":{"type":"object","properties":{"env":{"type":"string","example":"compart"}}}}},"userGroupsEmptyRelationship":{"type":"object","required":["links","data"],"properties":{"links":{"$ref":"#/components/schemas/UserGroupRelationshipsLinks"},"data":{"type":"array","items":{"type":"string"},"example":[]}}},"userRolesEmptyRelationship":{"type":"object","required":["links","data"],"properties":{"links":{"$ref":"#/components/schemas/UserRoleRelationshipsLinks"},"data":{"type":"array","items":{"type":"string"},"example":[]}}},"userGroupsRelationship":{"type":"object","required":["links","data"],"properties":{"links":{"$ref":"#/components/schemas/UserGroupRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/groupResourceObjectIdentifier"}}}},"userRolesRelationship":{"type":"object","required":["links","data"],"properties":{"links":{"$ref":"#/components/schemas/UserRoleRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/roleResourceObjectIdentifier"}}}},"groupUsersEmptyRelationship":{"type":"object","required":["links","data"],"properties":{"links":{"$ref":"#/components/schemas/GroupUserRelationshipsLinks"},"data":{"type":"array","items":{"type":"string"},"example":[]}}},"groupGroupsEmptyRelationship":{"type":"object","required":["links","data"],"properties":{"links":{"$ref":"#/components/schemas/GroupGroupRelationshipsLinks"},"data":{"type":"array","items":{"type":"string"},"example":[]}}},"groupRolesEmptyRelationship":{"type":"object","required":["links","data"],"properties":{"links":{"$ref":"#/components/schemas/GroupRoleRelationshipsLinks"},"data":{"type":"array","items":{"type":"string"},"example":[]}}},"groupUsersRelationship":{"type":"object","required":["links","data"],"properties":{"links":{"$ref":"#/components/schemas/GroupUserRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/userResourceObjectIdentifier"}}}},"groupGroupsRelationship":{"type":"object","required":["links","data"],"properties":{"links":{"$ref":"#/components/schemas/GroupGroupRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/groupResourceObjectIdentifier"}}}},"groupRolesRelationship":{"type":"object","required":["links","data"],"properties":{"links":{"$ref":"#/components/schemas/GroupRoleRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/roleResourceObjectIdentifier"}}}},"roleUsersEmptyRelationship":{"type":"object","required":["links","data"],"properties":{"links":{"$ref":"#/components/schemas/RoleUserRelationshipsLinks"},"data":{"type":"array","items":{"type":"string"},"example":[]}}},"roleGroupsEmptyRelationship":{"type":"object","required":["links","data"],"properties":{"links":{"$ref":"#/components/schemas/RoleGroupRelationshipsLinks"},"data":{"type":"array","items":{"type":"string"},"example":[]}}},"rolePermissionsEmptyRelationship":{"type":"object","required":["links","data"],"properties":{"links":{"$ref":"#/components/schemas/RolePermissionRelationshipsLinks"},"data":{"type":"array","items":{"type":"string"},"example":[]}}},"roleUsersRelationship":{"type":"object","required":["links","data"],"properties":{"links":{"$ref":"#/components/schemas/RoleUserRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/userResourceObjectIdentifier"}}}},"roleGroupsRelationship":{"type":"object","required":["links","data"],"properties":{"links":{"$ref":"#/components/schemas/RoleGroupRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/groupResourceObjectIdentifier"}}}},"rolePermissionsRelationship":{"type":"object","required":["links","data"],"properties":{"links":{"$ref":"#/components/schemas/RolePermissionRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/permissionResourceObjectIdentifier"}}}},"permissionRolesEmptyRelationship":{"type":"object","required":["links","data"],"properties":{"links":{"$ref":"#/components/schemas/PermissionRoleRelationshipsLinks"},"data":{"type":"array","items":{"type":"string"},"example":[]}}},"permissionRolesRelationship":{"type":"object","required":["links","data"],"properties":{"links":{"$ref":"#/components/schemas/PermissionRoleRelationshipsLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/roleWithMetaResourceObjectIdentifier"}}}},"userResourceObjectIdentifier":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["users"]},"id":{"type":"string","example":"john"}}},"groupResourceObjectIdentifier":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["groups"]},"id":{"type":"string","example":"developers"}}},"subgroupResourceObjectIdentifier":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["groups"]},"id":{"type":"string","example":"java-developers"}}},"roleResourceObjectIdentifier":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["roles"]},"id":{"type":"string","example":"ANA_ADMIN"}}},"roleWithMetaResourceObjectIdentifier":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["roles"]},"id":{"type":"string","example":"ANA_ADMIN"},"meta":{"type":"object","properties":{"env":{"type":"string","example":"compart"}}}}},"permissionResourceObjectIdentifier":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["permissions"]},"id":{"type":"string","example":"TENANT_LIST"}}},"permissionWithMetaResourceObjectIdentifier":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["permissions"]},"id":{"type":"string","example":"TENANT_LIST"},"meta":{"type":"object","properties":{"env":{"type":"string","example":"compart"}}}}},"ClientAttributes":{"type":"object","properties":{"secret":{"type":"string","example":"secret"},"scopes":{"type":"array","items":{"type":"string"},"example":["webclient","cliclient"]},"resourceIds":{"type":"array","items":{"type":"string"},"example":["api1","api2"]},"authorizedGrantTypes":{"type":"array","items":{"type":"string"},"example":["password","refresh_token","authorization_code"]},"redirectUris":{"type":"array","items":{"type":"string"},"example":["https://localhost:8445/PostageOptimizationModule/ui","https://172.20.16.167:8445/PostageOptimizationModule/ui"]},"autoApproveScopes":{"type":"array","items":{"type":"string"},"example":["webclient"]},"accessTokenValidity":{"type":"integer","example":43200},"refreshTokenValidity":{"type":"integer","example":2592000}}},"ClientAttributesWithHashedSecret":{"type":"object","properties":{"secret":{"type":"string","example":"$2a$10$J60yYygtfroraay41gwqHe.ML8/3dRT3jVZpTmNlA4B11/iC0EwAu"},"scopes":{"type":"array","items":{"type":"string"},"example":["webclient","cliclient"]},"resourceIds":{"type":"array","items":{"type":"string"},"example":["api1","api2"]},"authorizedGrantTypes":{"type":"array","items":{"type":"string"},"example":["password","refresh_token","authorization_code"]},"redirectUris":{"type":"array","items":{"type":"string"},"example":["https://localhost:8445/PostageOptimizationModule/ui","https://172.20.16.167:8445/PostageOptimizationModule/ui"]},"autoApproveScopes":{"type":"array","items":{"type":"string"},"example":["webclient"]},"accessTokenValidity":{"type":"integer","example":43200},"refreshTokenValidity":{"type":"integer","example":2592000}}},"ClientLinks":{"type":"object","required":["self"],"properties":{"self":{"type":"string","example":"/clients/pom"}}},"ClientData":{"type":"object","required":["type","id","attributes"],"properties":{"type":{"type":"string","enum":["clients"]},"id":{"type":"string","example":"pom"},"attributes":{"$ref":"#/components/schemas/ClientAttributes"}}},"ClientDataWithHashedSecret":{"type":"object","required":["type","id","attributes"],"properties":{"type":{"type":"string","enum":["clients"]},"id":{"type":"string","example":"pom"},"attributes":{"$ref":"#/components/schemas/ClientAttributesWithHashedSecret"}}},"ClientDataWithoutId":{"type":"object","required":["attributes"],"properties":{"attributes":{"$ref":"#/components/schemas/ClientAttributes"}}},"UserGroupRelationshipsLinks":{"type":"object","properties":{"self":{"type":"string","example":"/users/john/relationships/groups"}}},"UserRoleRelationshipsLinks":{"type":"object","properties":{"self":{"type":"string","example":"/users/john/relationships/roles"}}},"GroupUserRelationshipsLinks":{"type":"object","properties":{"self":{"type":"string","example":"/groups/developers/relationships/users"}}},"GroupRoleRelationshipsLinks":{"type":"object","properties":{"self":{"type":"string","example":"/groups/developers/relationships/roles"}}},"GroupGroupRelationshipsLinks":{"type":"object","properties":{"self":{"type":"string","example":"/groups/developers/relationships/groups"}}},"RoleUserRelationshipsLinks":{"type":"object","properties":{"self":{"type":"string","example":"/roles/POM_ADMIN/relationships/users"}}},"RoleGroupRelationshipsLinks":{"type":"object","properties":{"self":{"type":"string","example":"/roles/POM_ADMIN/relationships/groups"}}},"RolePermissionRelationshipsLinks":{"type":"object","properties":{"self":{"type":"string","example":"/roles/POM_ADMIN/relationships/permissions"}}},"PermissionRoleRelationshipsLinks":{"type":"object","properties":{"self":{"type":"string","example":"/permissions/TENANT_LIST/relationships/roles"}}},"UsersXml":{"type":"string","format":"binary","example":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><usr:Authentication xmlns:usr=\"http://www.compart.com/ns/ana/user/v1.0.0\"> <usr:Users><usr:User username=\"test\" password=\"$2a$10$U1B2MWPGT0rv4cwZVG/1hu/reg3qJJCYVUT/9CRL24VwinCU30MZu\"><usr:UserDisplayName>Test Testinger</usr:UserDisplayName><usr:Organization>Development</usr:Organization><usr:Location>Third Floor</usr:Location><usr:Telephone>123</usr:Telephone><usr:Email>test.testinger@compart.com</usr:Email></usr:User><usr:User username=\"john\" password=\"$2a$10$HOE/hyW7DE1bBkyrPju1Leq7CKOLnA22hCR9KnK9ds4h9l7ja8yt2\"><usr:UserDisplayName>John Testinger</usr:UserDisplayName><usr:Organization>CEO</usr:Organization><usr:Location>First Floor</usr:Location><usr:Telephone>234</usr:Telephone><usr:Email>john.testinger@compart.com</usr:Email></usr:User><usr:User username=\"dan\" password=\"$2a$10$.GRumHHXNb4WHDChQZ9QROjMB.P7HonEmR0oYnh5LrUdgLtUrEnkO\"><usr:UserDisplayName>Dan User</usr:UserDisplayName><usr:Organization>Development</usr:Organization><usr:Location>Third Floor</usr:Location><usr:Telephone>345</usr:Telephone><usr:Email>dan.user@compart.com</usr:Email></usr:User><usr:User username=\"joe\" password=\"$2a$10$Ggy3l/bxTsK2x7wzGIGKSOtyRXx1BTmrvWvOlZ0AJ5bmOGL7SDD02\"><usr:UserDisplayName>Joe Board</usr:UserDisplayName><usr:Organization>Management</usr:Organization><usr:Location>Fourth Floor on the Right</usr:Location><usr:Telephone>456</usr:Telephone><usr:Email>joe.board@compart.com</usr:Email></usr:User></usr:Users><usr:Groups><usr:Group groupname=\"developers\"><usr:GroupDisplayName>Development</usr:GroupDisplayName><usr:GroupDescription>Members of Development</usr:GroupDescription><usr:Members><usr:Member type=\"user\" name=\"test\" /><usr:Member type=\"user\" name=\"dan\" /></usr:Members></usr:Group><usr:Group groupname=\"guests\"><usr:GroupDisplayName>Guests</usr:GroupDisplayName><usr:GroupDescription>Guests</usr:GroupDescription><usr:Members><usr:Member type=\"user\" name=\"joe\" /><usr:Member type=\"user\" name=\"john\" /></usr:Members></usr:Group><usr:Group groupname=\"administrators\"><usr:GroupDisplayName>Administration</usr:GroupDisplayName><usr:GroupDescription>Members of System Administration</usr:GroupDescription><usr:Members><usr:Member type=\"user\" name=\"test\" /><usr:Member type=\"group\" name=\"developers\" /></usr:Members></usr:Group></usr:Groups></usr:Authentication>"},"Authentication":{"type":"object","properties":{"Users":{"type":"array","items":{"$ref":"#/components/schemas/User"}},"Groups":{"type":"array","items":{"$ref":"#/components/schemas/Group"}}},"xml":{"prefix":"usr","namespace":"http://www.compart.com/ns/ana/user/v1.0.0"}},"User":{"type":"array","items":{"$ref":"#/components/schemas/UserSingle"},"xml":{"prefix":"usr","wrapped":true,"name":"Users"}},"UserSingle":{"type":"object","properties":{"username":{"$ref":"#/components/schemas/username"},"password":{"$ref":"#/components/schemas/password"},"UserDisplayName":{"$ref":"#/components/schemas/UserDisplayName"},"Organization":{"$ref":"#/components/schemas/Organization"},"Location":{"$ref":"#/components/schemas/Location"},"Telephone":{"$ref":"#/components/schemas/Telephone"},"Email":{"$ref":"#/components/schemas/Email"}},"xml":{"prefix":"usr","name":"User"}},"username":{"type":"string","example":"test","xml":{"prefix":"usr","name":"username","attribute":true}},"password":{"type":"string","example":"$2a$10$mimFQ0HbIZhvfuv.zBMXAe34XyThokqWdk7pBu9Y2tFfGh4CgeahS","xml":{"prefix":"usr","name":"password","attribute":true}},"UserDisplayName":{"type":"string","example":"Test Testinger","xml":{"prefix":"usr","name":"UserDisplayName"}},"Organization":{"type":"string","example":"Development","xml":{"prefix":"usr","name":"Organization"}},"Location":{"type":"string","example":"Third Floor","xml":{"prefix":"usr","name":"Location"}},"Telephone":{"type":"string","example":"498","xml":{"prefix":"usr","name":"Telephone"}},"Email":{"type":"string","example":"test.testinger@compart.com","xml":{"prefix":"usr","name":"Email"}},"Group":{"type":"array","items":{"$ref":"#/components/schemas/GroupSingle"},"xml":{"prefix":"usr","wrapped":true,"name":"Groups"}},"GroupSingle":{"type":"object","properties":{"groupname":{"$ref":"#/components/schemas/groupname"},"GroupDisplayName":{"$ref":"#/components/schemas/GroupDisplayName"},"GroupDescription":{"$ref":"#/components/schemas/GroupDescription"},"Members":{"$ref":"#/components/schemas/Members"}},"xml":{"prefix":"usr","name":"Group"}},"groupname":{"type":"string","example":"testers","xml":{"prefix":"usr","name":"groupname","attribute":true}},"GroupDisplayName":{"type":"string","example":"Development","xml":{"prefix":"usr","name":"GroupDisplayName"}},"GroupDescription":{"type":"string","example":"testers group","xml":{"prefix":"usr","name":"GroupDescription"}},"Members":{"type":"object","properties":{"Member1":{"$ref":"#/components/schemas/Member1"},"Member2":{"$ref":"#/components/schemas/Member2"}},"xml":{"wrapped":true,"prefix":"usr"}},"Member1":{"type":"object","properties":{"type":{"type":"string","enum":["user","group"],"xml":{"attribute":true},"example":"user"},"name":{"type":"string","xml":{"attribute":true},"example":"john"}},"xml":{"prefix":"usr","name":"Member"}},"Member2":{"type":"object","properties":{"type":{"type":"string","enum":["user","group"],"xml":{"attribute":true},"example":"group"},"name":{"type":"string","xml":{"attribute":true},"example":"javascript-testers"}},"xml":{"prefix":"usr","name":"Member"}},"RoleManagement":{"type":"object","properties":{"Roles":{"type":"array","items":{"$ref":"#/components/schemas/Role"}}},"xml":{"prefix":"rle","namespace":"http://www.compart.com/ns/ana/role/v1.0.0"}},"Role":{"type":"array","items":{"$ref":"#/components/schemas/RoleSingle"},"xml":{"prefix":"rle","wrapped":true,"name":"Roles"}},"RoleSingle":{"type":"object","properties":{"name":{"type":"string","example":"ANA_USER","xml":{"attribute":true}},"RoleDescription":{"$ref":"#/components/schemas/RoleDescription"},"RoleMember1":{"$ref":"#/components/schemas/RoleMember1"},"RoleMember2":{"$ref":"#/components/schemas/RoleMember2"}},"xml":{"prefix":"rle","name":"Role"}},"RoleDescription":{"type":"string","example":"This role gives access to Authentication and Authorization reading services","xml":{"prefix":"rle","name":"RoleDescription"}},"RoleMember1":{"type":"object","properties":{"type":{"type":"string","enum":["user","group"],"xml":{"attribute":true},"example":"user"},"name":{"type":"string","xml":{"attribute":true},"example":"john"}},"xml":{"prefix":"rle","name":"RoleMember"}},"RoleMember2":{"type":"object","properties":{"type":{"type":"string","enum":["user","group"],"xml":{"attribute":true},"example":"group"},"name":{"type":"string","xml":{"attribute":true},"example":"testers"}},"xml":{"prefix":"rle","name":"RoleMember"}},"PermissionManagement":{"type":"object","properties":{"Permissions":{"type":"array","items":{"$ref":"#/components/schemas/Permission"}},"PermissionMappings":{"type":"array","items":{"$ref":"#/components/schemas/PermissionMapping"}}},"xml":{"prefix":"prm","namespace":"http://www.compart.com/ns/ana/permission/v1.1.0"}},"Permission":{"type":"array","items":{"$ref":"#/components/schemas/PermissionSingle"},"xml":{"prefix":"prm","name":"Permissions"}},"PermissionSingle":{"type":"object","properties":{"Permission1":{"$ref":"#/components/schemas/PermissionSingle1"},"Permission2":{"$ref":"#/components/schemas/PermissionSingle2"}}},"PermissionSingle1":{"type":"object","properties":{"name":{"type":"string","example":"POM_TENANT_LIST","xml":{"attribute":true}},"PermissionDescription":{"$ref":"#/components/schemas/PermissionDescription"}},"xml":{"prefix":"prm","name":"Permission"}},"PermissionSingle2":{"type":"object","properties":{"name":{"type":"string","example":"POM_TENANT_CREATE","xml":{"attribute":true}},"PermissionDescription":{"$ref":"#/components/schemas/PermissionDescription2"}},"xml":{"prefix":"prm","name":"Permission"}},"PermissionDescription":{"type":"string","example":"List tenants in POM","xml":{"prefix":"prm","name":"PermissionDescription"}},"PermissionDescription2":{"type":"string","example":"Create tenants in POM","xml":{"prefix":"prm","name":"PermissionDescription"}},"PermissionMapping":{"type":"array","items":{"$ref":"#/components/schemas/PermissionMappingSingle"},"xml":{"prefix":"prm","wrapped":true,"name":"PermissionMappings"}},"PermissionMappingSingle":{"type":"object","properties":{"env":{"type":"string","example":"compart","xml":{"attribute":true}},"role":{"type":"string","example":"POM_ADMIN","xml":{"attribute":true}},"Permission3":{"$ref":"#/components/schemas/PermissionSingle3"},"Permission4":{"$ref":"#/components/schemas/PermissionSingle4"}},"xml":{"prefix":"prm","name":"PermissionMapping"}},"PermissionSingle3":{"type":"object","properties":{"name":{"type":"string","example":"POM_TENANT_LIST","xml":{"attribute":true}}},"xml":{"prefix":"prm","name":"Permission"}},"PermissionSingle4":{"type":"object","properties":{"name":{"type":"string","example":"POM_TENANT_CREATE","xml":{"attribute":true}}},"xml":{"prefix":"prm","name":"Permission"}}},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"},"OAuth2":{"type":"oauth2","flows":{"password":{"tokenUrl":"https://example.com/oauth/token","refreshUrl":"https://example.com/oauth/token","scopes":{"ANA_USER":"Role to grant read only access to A&A basic services","ANA_ADMIN":"Role to grant complete access to A&A basic services","SCOPE_XML":"Scope to grant access to permissions.xml import service"}}}}}}}