Returns information for a specified user on a network
bsn.api.main.users.retrieve
______________________________________________________________
login
string
The login information of the user
______________________________________________________________
200: Returns the User Entity
304: The resource was not modified since the time specified in the “If-Modified-Since” header
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
Updates information for a specified user on a network
bsn.api.main.users.update
______________________________________________________________
login
string
The login information of the user
______________________________________________________________
The User Entity
______________________________________________________________
204: The user information has been updated
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
Deletes the specified user on a network
bsn.api.main.users.delete
______________________________________________________________
login
string
The login information of the user
______________________________________________________________
204: The specified user information was successfully deleted
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
Returns information for a specified user on a network.
bsn.api.main.users.retrieve
______________________________________________________________
id
int
A unique identifier for a user
______________________________________________________________
200: Returns the User Entity
304: The resource was not modified since the time specified in the “If-Modified-Since” header
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
Update the given user instance
bsn.api.main.users.update
______________________________________________________________
id
int
A unique identifier for a user
______________________________________________________________
The User Entity
______________________________________________________________
204: The user information has been updated
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
Deletes information for a specified user on a network
bsn.api.main.users.delete
______________________________________________________________
id
int
A unique identifier for a user
______________________________________________________________
204: The specified user information was successfully deleted
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
Returns the operational permissions granted to roles for specific business operations
bsn.api.main.operations.retrieve
______________________________________________________________
200: Returns the Business Operations Entity
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
Returns object permissions for a given user instance
bsn.api.main.users.retrieve
______________________________________________________________
id
int
A unique identifier for a user
______________________________________________________________
200: Returns an array of Permission entities
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
Adds permissions for a specified user on a network
bsn.api.main.users.update
______________________________________________________________
id
int
A unique identifier for a user
______________________________________________________________
An array of Permission entities
______________________________________________________________
204: The permissions were successfully added to the specified user instance
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
Removes permissions for a specified user on a network
bsn.api.main.users.update
______________________________________________________________
id
int
A unique identifier for a user
______________________________________________________________
An array of Permission entities
______________________________________________________________
204: The specified user permissions were successfully deleted
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
Returns object permissions for a given user instance.
bsn.api.main.users.retrieve
______________________________________________________________
login
string
The login information of the user
______________________________________________________________
200: Returns an array of Permission entities
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
Adds permissions for a specified user on a network
bsn.api.main.users.update
______________________________________________________________
login
string
The login information of the user
______________________________________________________________
An array of Permission entities
______________________________________________________________
204: The permissions were successfully added to the specified user instance
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
Removes permissions for a specified user on a network
bsn.api.main.users.update
______________________________________________________________
login
string
The login information of the user
______________________________________________________________
An array of Permission entities
______________________________________________________________
204: The specified user permissions were successfully deleted
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
Validates the the user access or refresh token granted to the specified user
bsn.api.main.users.token.validate
______________________________________________________________
id
int
A unique identifier for a user
token
string
A user access or refresh token for a BSN.cloud network
______________________________________________________________
200: Returns the Token Info Entity
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
Revokes user access or refresh tokens for the specified user
bsn.api.main.users.token.revoke
______________________________________________________________
id
int
A unique identifier for a user
token
string
The user access or refresh token to use with this endpoint call
______________________________________________________________
204: The user access or refresh token has been successfully revoked from the specified user
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
Validates the user access or refresh token granted to the specified user
bsn.api.main.users.token.validate
______________________________________________________________
login
int
The login for the user
token
string
A user access or refresh token for a BSN.cloud network
______________________________________________________________
200: Returns the Token Info Entity
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
Revokes the user access or refresh token granted to the specified user
bsn.api.main.users.token.revoke
______________________________________________________________
login
int
The login for the user
token
string
A user access or refresh token for a BSN.cloud network
______________________________________________________________
204: The user access or refresh token has been successfully revoked from the specified user
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