{login}/GET
Returns information for a specified user on a networka specified user on a network
Required Scope Token
bsn.api.main.users.retrieve
______________________________________________________________
Segment
login string
The login information of the user
______________________________________________________________
Response
Success Response with Body
200: Returns the User Entity
Success Response
304: The resource was not modified since the time specified in the “If-Modified-Since” header
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
404: The server cannot find the requested resource (the path does not exist)
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
5XX: Any 500 code is an internal server error
{login}/PUT
Updates information for a specified user on a networka specified user on a network
Required Scope Token
bsn.api.main.users.update
______________________________________________________________
Segment
login string
The login information of the user
______________________________________________________________
Request Body
The User Entity
______________________________________________________________
Response
Success
204: The user information has been updated
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: Either the request or request body is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
404: The server cannot find the requested resource (the path does not exist)
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
412: Precondition failed (the resource changed since the time specified in the “If-Unmodified-Since” header value)
415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)
5XX: Any 500 code is an internal server error
{login}/DELETE
Deletes the specified user on a networkspecified user on a network
Required Scope Token
bsn.api.main.users.delete
______________________________________________________________
Segment
login string
The login information of the user
______________________________________________________________
Response
Success
204: The specified user information was successfully deleted
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
404: The server cannot find the requested resource (the path does not exist)
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
412: Precondition failed (the resource changed since the time specified in the “If-Unmodified-Since” header value)
5XX: Any 500 code is an internal server error
{id:int}/GET
Returns information for a specified user on a network.a specified user on a network.
Required Scope Token
bsn.api.main.users.retrieve
______________________________________________________________
Segment
id int
A unique identifier for a user
______________________________________________________________
Response
Success Response with Body
200: Returns the User Entity
Success Response
304: The resource was not modified since the time specified in the “If-Modified-Since” header
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
404: The server cannot find the requested resource (the path does not exist)
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
5XX: Any 500 code is an internal server error
{id:int}/PUT
Update the given user instanceUpdate the given user instance
Required Scope Token
bsn.api.main.users.update
______________________________________________________________
Segment
id int
A unique identifier for a user
______________________________________________________________
Request Body
The User Entity
______________________________________________________________
Response
Success
204: The user information has been updated
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: Either the request or request body is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
404: The server cannot find the requested resource (the path does not exist)
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
412: Precondition failed (the resource changed since the time specified in the “If-Unmodified-Since” header value)
415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)
5XX: Any 500 code is an internal server error
{id:int}/DELETE
Deletes information for a specified user on a networka specified user on a network
Required Scope Token
bsn.api.main.users.delete
______________________________________________________________
Segment
id int
A unique identifier for a user
______________________________________________________________
Response
Success
204: The specified user information was successfully deleted
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
404: The server cannot find the requested resource (the path does not exist)
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
412: Precondition failed (the resource changed since the time specified in the “If-Unmodified-Since” header value)
5XX: Any 500 code is an internal server error
Operations/GET
Returns the operational permissions granted to roles for specific business operationsroles for specific business operations
Required Scope Token
bsn.api.main.operations.retrieve
______________________________________________________________
Response
Success Response Body
200: Returns the Business Operations Entity
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
5XX: Any 500 code is an internal server error
{id:int}/Permissions/GET
Returns object permissions for a given user instancepermissions for a given user instance
Required Scope Token
bsn.api.main.users.retrieve
______________________________________________________________
Segment
id int
A unique identifier for a user
______________________________________________________________
Response
Success Response Body
200: Returns an array of Permission entities
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
404: The server cannot find the requested resource (the path does not exist)
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
5XX: Any 500 code is an internal server error
{id:int}/Permissions/POST
Adds permissions for a specified user on a networka specified user on a network
Required Scope Token
bsn.api.main.users.update
______________________________________________________________
Segment
id int
A unique identifier for a user
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
Response
Success
204: The permissions were successfully added to the specified user instance
Failure
400: The request or request body is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
404: The server cannot find the requested resource (the path does not exist)
415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)
5XX: Any 500 code is an internal server error
{id:int}/Permissions/DELETE
Removes permissions for a specified user on a networka specified user on a network
Required Scope Token
bsn.api.main.users.update
______________________________________________________________
Segment
id int
A unique identifier for a user
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
Response
Success
204: The specified user permissions were successfully deleted
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request or request body is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
404: The server cannot find the requested resource (the path does not exist)
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
5XX: Any 500 code is an internal server error
{login}/Permissions/GET
Returns object permissions for a given user instance.a given user instance.
Required Scope Token
bsn.api.main.users.retrieve
______________________________________________________________
Segment
login string
The login information of the user
______________________________________________________________
Response
Success Response Body
200: Returns an array of Permission entities
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
404: The server cannot find the requested resource (the path does not exist)
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
5XX: Any 500 code is an internal server error
{login}/Permissions/POST
Adds permissions for a specified user on a networka specified user on a network
Required Scope Token
bsn.api.main.users.update
______________________________________________________________
Segment
login string
The login information of the user
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
Response
Success
204: The permissions were successfully added to the specified user instance
Failure
400: The request or request body is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
404: The server cannot find the requested resource (the path does not exist)
415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)
5XX: Any 500 code is an internal server error
{login}/Permissions/DELETE
Removes permissions for a specified user on a networkuser on a network
Required Scope Token
bsn.api.main.users.update
______________________________________________________________
Segment
login string
The login information of the user
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
Response
Success
204: The specified user permissions were successfully deleted
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request or request body is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
404: The server cannot find the requested resource (the path does not exist)
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
5XX: Any 500 code is an internal server error
{id:int}/Tokens/{token}/GET
Validates the the user access or refresh token granted to the specified usertoken granted to the specified user
Required Scope Token
bsn.api.main.users.token.validate
______________________________________________________________
Segments
id int
A unique identifier for a user
token string
A user access or refresh token for a BSN.cloud network
______________________________________________________________
Response
Success Response Body
200: Returns the Token Info Entity
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
404: The server cannot find the requested resource (the path does not exist)
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
5XX: Any 500 code is an internal server error
{id:int}/Tokens/{token}/DELETE
Revokes user access or refresh tokens for the specified userfor the specified user
Required Scope Token
bsn.api.main.users.token.revoke
______________________________________________________________
Segments
id int
A unique identifier for a user
token string
The user access or refresh token to use with this endpoint call
______________________________________________________________
Response
Success
204: The user access or refresh token has been successfully revoked from the specified user
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request body is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
404: Either the specified token is invalid, expired, or revoked, or it is issued for another user
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
5XX: Any 500 code is an internal server error
{login}/Tokens/{token}/GET
Validates the user access or refresh token granted to the specified usertoken granted to the specified user
Required Scope Token
bsn.api.main.users.token.validate
______________________________________________________________
Segments
login int
The login for the user
token string
A user access or refresh token for a BSN.cloud network
______________________________________________________________
Response
Success Response Body
200: Returns the Token Info Entity
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
404: The server cannot find the requested resource (the path does not exist)
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
5XX: Any 500 code is an internal server error
{login}/Tokens/{token}/DELETE
Revokes the user access or refresh token granted to the specified user
Required Scope Token
bsn.api.main.users.token.revoke
______________________________________________________________
Segments
login int
The login for the user
token string
A user access or refresh token for a BSN.cloud network
______________________________________________________________
Response
Success
204: The user access or refresh token has been successfully revoked from the specified user
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
404: Either the specified token is invalid, expired, or revoked, or it is issued for another user
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
5XX: Any 500 code is an internal server error