Self Endpoints (2020/10)

these endpoints allow users to manage their settings in the current network base url for these endpoints https //api bsn cloud/2020/10/rest get /self/ returns your person entity (2020/10) docid\ ad1cnhugxxwibzw9x8v2l information required scope token bsn api self info retrieve response success response with body 200 200 returns the person entity (2020/10) docid\ ad1cnhugxxwibzw9x8v2l success response 304 304 the resource was not modified since the time specified in the “if modified since” header failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error post /self/ registers the person and returns your person credentials (except the password if it was provided in your request) required scope token none request body the person entity (2020/10) docid\ ad1cnhugxxwibzw9x8v2l if you specify a password that matches our security policy, the server will apply the password you specify and will not return a password if you do not specify a password, the server will generate a password and return it to you response success response body 200 200 returns the person entity (2020/10) docid\ ad1cnhugxxwibzw9x8v2l failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 either the request or request body is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error get /self/tokens/{token}/ gets the status of the specified oauth2 person access or refresh token required scope token bsn api self token validate segment token string string a person access or refresh token response success response body 200 200 returns the token info entity failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the specified person or access refresh token is expired, revoked, or invalid 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error delete /self/tokens/{token}/ revokes a person access or refresh token required scope token bsn api self token revoke segment token string string a person access or refresh token response success 204 204 the person access or refresh token has been deleted failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the specified person or access refresh token is expired, revoked, or invalid 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /self/networks/ returns the networks associated with a person required scope token bsn api self networks retrieve response success response body 200 200 returns an array of network entity (2020/10) docid\ on6vibgubgvq o86l1ofb instances in which the current person is a member failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error post /self/networks/ creates a network for the person required scope token bsn api self networks create request body the network entity (2020/10) docid\ on6vibgubgvq o86l1ofb response success response body 201 201 returns the new resource created and referenced by the uri (given by the location header field) in the response the response includes the network entity (see network entity (2020/10) docid\ on6vibgubgvq o86l1ofb ) failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 either the request or request body is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error get /self/networks/{id\ int}/ returns a network associated with a specified id required scope token bsn api self networks retrieve segment id int int the unique identifier for a network response success response with body 200 200 returns the network entity (2020/10) docid\ on6vibgubgvq o86l1ofb success response 304 304 the resource was not modified since the time specified in the “if modified since” header failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /self/networks/{name}/ returns a network associated with a specified name required scope token bsn api self networks retrieve segment name string string the name of a network response success response body 200 200 returns the network entity (2020/10) docid\ on6vibgubgvq o86l1ofb success response 304 304 the resource was not modified since the time specified in the “if modified since” header failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /self/networks/{id\ int}/settings/ returns the settings associated with a specified network required scope token bsn api self networks retrieve segment id int int the unique identifier for a network response success response with body 200 200 returns the network settings entity (2020/10) docid 0s7famoe3rhkuder tqa6 success response 304 304 the resource was not modified since the time specified in the “if modified since” header failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error put /self/networks/{id\ int}/settings/ update the settings associated with a specified network required scope token bsn api self networks update segment id int int the unique identifier for a network request body the network settings entity (2020/10) docid 0s7famoe3rhkuder tqa6 response success 204 204 the specified settings have been updated on the network failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 either the request or request body is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error get /self/networks/{name}/settings/ get the settings associated with a specified network required scope token bsn api self networks retrieve segment name string string the name of a network response success response body 200 200 returns the network settings entity (2020/10) docid 0s7famoe3rhkuder tqa6 failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error put /self/networks/{name}/settings/ update the settings associated with a specified network required scope token bsn api self networks update segment name string string the name of a network request body the network settings entity (2020/10) docid 0s7famoe3rhkuder tqa6 response success 204 204 the network settings have been updated failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 either the request or request body is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error get /self/networks/{id\ int}/subscription/ returns the current subscription information associated with a specified network required scope token bsn api self networks retrieve segment id int int the unique identifier for a network response success response with body 200 200 returns the network subscription entity (2020/10) docid 4bfszcrh0y9jdu1nt3gsn success response 304 304 the resource was not modified since the time specified in the “if modified since” header failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error put /self/networks/{id\ int}/subscription/ updates the current subscription information associated with a specified network a regular user can only use this to enable a trial period of the content cloud (if it was not previously enabled) required scope token bsn api self networks update segment id int int the unique identifier for a network request body the network subscription entity (2020/10) docid 4bfszcrh0y9jdu1nt3gsn response success 204 204 the subscription information was updated failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 either the request or request body is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 412 412 precondition failed (the resource changed since the time specified in the “if unmodified since” header value) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error get /self/networks/{name}/subscription/ returns the current subscription information associated with a specified network required scope bsn api self networks retrieve segment name string string the name of a network response success response body 200 200 returns the network subscription entity (2020/10) docid 4bfszcrh0y9jdu1nt3gsn failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error put /self/networks/{name}/subscription/ updates the current subscription information associated with a specified network a regular user can only use this to enable a trial period of the content cloud (if it was not previously enabled) required scope token bsn api self networks update segment name string string the name of a network request body the network subscription entity (2020/10) docid 4bfszcrh0y9jdu1nt3gsn response success 204 204 updated the subscription information associated with the network failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 either the request or request body is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error get /self/networks/{id\ int}/subscriptions/ returns the current subscription, and all previously expired subscriptions, associated with a specified network required scope token bsn api self networks retrieve segment id int int the unique identifier for a network response success response body 200 200 returns an array of network subscription entity (2020/10) docid 4bfszcrh0y9jdu1nt3gsn entities failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /self/networks/{name}/subscriptions/ returns the current subscription, and all previously expired subscriptions, associated with a specified network required scope token bsn api self networks retrieve segment name string string the name of a network response success response body 200 200 returns an array of network subscription entity (2020/10) docid 4bfszcrh0y9jdu1nt3gsn entities failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /self/users/ returns all user entities that the customer is associated with over all networks where the person has a user record required scope token bsn api self users retrieve response success response body 200 200 returns an array of user entities (see user entity (2020/10) docid\ jirqabyicrjavih3z4zeq ) if the user is a member of multiple networks, or to a single user entity (2020/10) docid\ jirqabyicrjavih3z4zeq if the user is only a member of one network, or nothing if the user is not a member of any network failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /self/users/{id\ int}/ returns information about your membership in a network required scope token bsn api self users retrieve segment id int int the unique identifier for a user response success response with body 200 200 returns the user entity (2020/10) docid\ jirqabyicrjavih3z4zeq success response 304 304 the resource was not modified since the time specified in the “if modified since” header failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /self/users/{id\ int}/role/ returns information about the role you have in a network required scope token bsn api self roles retrieve segment id int int the unique identifier for a user response success response with body 200 200 this returns the user entity (2020/10) docid\ jirqabyicrjavih3z4zeq success response 204 204 no content (the user is not assigned to a role) failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /self/users/{id\ int}/profile/ returns the user profile settings required scope token bsn api self users profile retrieve segment id int int the unique identifier for a user response success response body 200 200 the return type is object, where property names are profile keys and the profile values are those property values failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error post /self/users/{id\ int}/profile/ creates a new user profile property (it does not replace an existing user profile property) required scope token bsn api self users profile update segment id int int the unique identifier for a user request body pair < string, string> string, string> a key value pair there should be not more than 100 properties per user, and each property value should be not more than 64kb response success response body 201 201 returns the key value pair and a link to the get method to retrieve it failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 either the request or request body is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 409 409 the profile property with the specified key already exists or is reserved 413 413 the specified profile property value size exceeds the 64kb limit 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error get /self/users/{id\ int}/profile/{key}/ returns the value of a user profile key required scope token bsn api self users profile retrieve segment id int int the unique identifier for a user key string string the name of the profile property response success response with body 200 200 returns the value of the requested user profile key success response 304 304 the resource was not modified since the time specified in the “if modified since” header failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error put /self/users/{id\ int}/profile/{key}/ creates or updates the value of a user property value required scope token bsn api self users profile update segments id int int the unique identifier for a user key string string the name of the profile property request body string string the profile property value to update response success 201 201 returns this status code if the property value is defined for first time 204 204 returns this status code if the property already exists and has been updated failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 either the request is malformed and therefore invalid, or the specified user profile property key is reserved or longer than 62 characters 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 412 412 precondition failed (the resource changed since the time specified in the “if unmodified since” header value) 413 413 the length of the specified user profile property exceeds the 64kb limit 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error delete /self/users/{id\ int}/profile/{key}/ removes a specified property from a user profile required scope token bsn api self users profile update segments id int int the unique identifier for a user key string string the name of the profile property response success 204 204 the specified property has been removed from the user profile failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 412 412 precondition failed (the resource changed since the time specified in the “if unmodified since” header value) 5xx 5xx any 500 code is an internal server error get /self/users/{id\ int}/notifications/ returns the user notification settings required scope token bsn api self users notifications retrieve segment id int int a unique identifier for a user response success response body 200 200 returns information about whether each setting in user notification settings entity (2020/10) docid\ eilgsu2e52juy3tik3uke is enabled or disabled failure 300 300 the user entity is not specified correctly (there is more than one possible response) 400 400 either the request or the user entity is invalid or not specified 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error put /self/users/{id\ int}/notifications/ updates the user notification settings required scope token bsn api self users notifications update segment id int int a unique identifier for a user request body the user notification settings entity (2020/10) docid\ eilgsu2e52juy3tik3uke response success 204 204 the specified user notification settings have been updated on the network failure 300 300 an acceptable user notification settings entity is not specified 400 400 either the request or the user entity is invalid or not specified 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 415 415 the specified representation of the user notification settings entity is invalid or not supported 5xx 5xx any 500 code is an internal server error get /self/profile/ returns a complete person profile required scope token bsn api self profile retrieve response success response with body 200 200 the return type is object, where property names are profile keys and the profile values are those property values failure 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 5xx 5xx any 500 code is an internal server error post /self/profile/ creates a new profile property for the person required scope token bsn api self profile update request body pair \<string, string> \<string, string> a key value pair of the person profile property response success response body 201 201 returns the new resource created and referenced by the uri (given by the location header field) in the response returns an object where property names correspond to profile keys and property values correspond to profile names failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 either the request is malformed and therefore invalid, or the specified profile property key is reserved or longer than 62 characters 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 409 409 the person profile property with the specified key already exists 413 413 the length of the specified person property profile value exceeds the 64kb limit 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error get /self/profile/{key}/ returns a profile property value for a person required scope token bsn api self profile retrieve segment key string string the name of the profile property response success response body 200 200 returns a profile property value success response 304 304 the resource was not modified since the time specified in the “if modified since” header failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error put /self/profile/{key}/ creates or updates a person profile property value required scope token bsn api self profile update segment key string string the name of the profile property request body string string the profile property value to update response success 201 201 returns this status code if the person property value is defined for first time 204 204 returns this status code if the person property value already exists and has been updated failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 either the request or request body is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 412 412 precondition failed (the resource changed since the time specified in the “if unmodified since” header value) 413 413 the length of the specified user profile property exceeds the 64kb limit 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error delete /self/profile/{key}/ removes a profile property for a person required scope token bsn api self profile update segment key string string the name of the profile property response success 204 204 the profile property has been removed failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 412 412 precondition failed (the resource changed since the time specified in the “if unmodified since” header value) 5xx 5xx any 500 code is an internal server error get /self/users/{id\ int}/permissions/ returns the permissions granted to a given user required scope token bsn api self users retrieve segment id int int a unique identifier for a user response success response body 200 200 returns the paged list of permission entity (2020/10) docid 9p ncidl9xh7qdpkxgodl entities granted to a specific user failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /self/users/{id\ int}/role/permissions/ returns the permissions granted to a a given user required scope token bsn api self roles retrieve segment id int int a unique identifier for a user response success response body 200 200 returns the array of permission entity (2020/10) docid 9p ncidl9xh7qdpkxgodl entities granted to a specific role failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error