These endpoints enable management of users on a network. A user is an instance of a person that is associated with a single network (there can only be one person, but there can be 0 to an infinite number of users on a network).
Base URL for these endpoints: https://api.bsn.cloud/2020/10/REST/Users/GET /{login}/
Returns information for a 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
PUT /{login}/
Updates information for a specified user on a network
Required Scope Token
bsn.api.main.users.update
______________________________________________________________
Segment
login string
The login information of the user
______________________________________________________________
Request Body
TheUser 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
DELETE /{login}/
Deletes the specified 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
GET /{id:int}/
Returns information for 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
PUT /{id:int}/
Update the given user instance
Required Scope Token
bsn.api.main.users.update
______________________________________________________________
Segment
id int
A unique identifier for a user
______________________________________________________________
Request Body
TheUser 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
DELETE /{id:int}/
Deletes information for a 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
GET /Operations/
Returns the operational permissions granted to roles 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
GET /{id:int}/Permissions/
Returns object permissions 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
POST /{id:int}/Permissions/
Adds permissions for a 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
DELETE /{id:int}/Permissions/
Removes permissions for a 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
______________________________________________________________
GET
Returns a list of user instances on a network
Query String Parameters
marker string optional
A value specifying which page to retrieve. This value is useful if the isTruncated entry in the response body of the previous GET call indicates that the number of user instances exceeds the pageSize.
This parameter is only required if you need more elements in the paged list than the pageSize (100).
pageSize int optional
The maximum number of user instances that can be contained in the response body. This defaults to the maximum allowed page size (100).
______________________________________________________________
Response Body
Returns a paged list of User Entity instances on a network. This will return not more than 100 entities along with the information necessary to return any other remaining pages.
POST
Creates a user instance on a network
Request Body
The User Entity
________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
GET /{login}/Permissions/
Returns object permissions for a given user instance.
Required Scope Token
bsn.api.main.users.retrieve
______________________________________________________
Response Body
Returns a 201 status code and the new resource created and referenced by the Uri (given by the Location header field) in the response. The response includes the User Entity.
{login}/GET
Returns information for a specified user on a network________
Segment
login
string
The login information of the user
_____________________________________________________________
Response Body
Returns the User Entity
Endpoints:
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
{login}/PUT
Updates information for a specified user on a network
Segment
login string
The login information of the user
______________________________________________________________
Request Body
The User Entity
__________
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
POST /{login}/Permissions/
Adds permissions for a specified user on a network
Required Scope Token
bsn.api.main.users.update
_____________________________________________________
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
{login}/DELETE
Deletes information for a specified user on a network
Segment
login string A unique identifier for a user_________
Segment
login string
The login information of the user
______________________________________________________________
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
{id:int}/GET
Returns information for a specified user on a network.
Segment
id int
Response Body
Returns the User Entity
{id:int}/PUT
Update the given user instance
Segment
id int
A unique identifier for a user
______________________________________________________________
Request Body
The User Entity_________________
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
DELETE /{login}/Permissions/
Removes permissions for a specified user on a network
Required Scope Token
bsn.api.main.users.update
______________________________________________________________
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
{id:int}/DELETE
Deletes information for a specified user on a network
Segment
id int
Segment
login string
The login information of the user
______________________________________________________________
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX
Operations/GET
Returns the operational permissions granted to roles for specific business operations
Response Body
Returns the Business Operations Entity
{id:int}/Permissions/GET
Returns object permissions for a given user instance.
Segment
id int
Response Body
Success
200: Returns the permissions property value of the User Entity as a paged list of user entities.
{id:int}/Permissions/POST
Adds permissions for a specified user on a network
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
GET /{id:int}/Tokens/{token}/
Validates the the user access or refresh token granted to the specified user
Required Scope Token
bsn.api.main.users.token.validate
_____________________________________________________________
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
{id:int}/Permissions/DELETE
Removes permissions for a specified user on a network
Segment_
Segments
id int
A unique identifier for a user
token string
A user access or refresh token for a BSN.cloud network
_____________________________________
Request Body
______________________________________________________________
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
{login}/Permissions/GET
Returns object permissions for a given user instance.
Segment
login string
The login information of the user
_________________________
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
DELETE /{id:int}/Tokens/{token}/
Revokes user access or refresh tokens for the specified user
Required Scope Token
bsn.api.main.users.token.revoke
______________________________________________________________
Segments
Success
200: Returns the permissions property value of the User Entity as a paged list of user entities.
{login}/Permissions/POST
Adds permissions for a specified user on a network
Segment
login string
id int
A unique identifier for a user
token string
The user access or refresh token to use with this endpoint call
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
{login}/Permissions/DELETE
Removes permissions for a specified user on a network
Segment
login string
The login information of the user
______________________________________________________________
Request Body
The Permission EntityResponse
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
GET /{login}/Tokens/{token}/
Validates the user access or refresh token granted to the specified user
Required Scope Token
bsn.api.main.users.token.validate
______________________________________________________________
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
{id:int}/Tokens/{token}/GET
Validates the specified user's token
Segments
id int
A unique identifier for a user
token string
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
{id:int}/Tokens/{token}/DELETE
Revokes tokens for the specified user
Segments
id int
A unique identifier for a user
token string
The token to use with this endpoint call
______________________________________________________________
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
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
DELETE /{login}/Tokens/{token}/
Revokes the
user
Segments
login int
The login for the user
token string
access or refresh token granted to the specified user
Required Scope Token
bsn.api.main.users.token.revoke
______________________________________________________________
Response Body
Returns the Token Info Entity
{login}/Tokens/{token}/DELETE
Revokes tokens for the specified user
Segments
login int
Segments
login int
The login for the user
token
string
A
user access or refresh token for a BSN.cloud network
_____________________________________________________________
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX._
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