Page Comparison

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

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

Success Response Body

200: 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.

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

POST

Creates a user instance on a network

Request Body

The User Entity

______________________________________________________________

Response

Success Response Body

201: Returns the User Entity created and referenced by the Uri (given by the Location header field) in the response.

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

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

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

Endpoints:

Table of Contents

maxLevel	2
indent	20px
exclude	Endpoints:

Returns information for a specified user on a network

Segment

login string

The login information of the user

______________________________________________________________

Response

Success Response with Body

200: Returns the User Entity

Updates information for a specified user on a network

Segment

login string

The login information of the user

______________________________________________________________

Request Body

The User Entity

______________________________________________________________

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX.

Deletes

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

Updates information for a specified user on a network

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

A unique identifier for a user

Request Body

The User Entity

______________________________________________________________

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 Body

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

A unique identifier for a user

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

Deletes the specified user on a network

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

A unique identifier for a user

______________________________________________________________

Response Body

Success

200: Returns an array of Permission entities

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

POSTAdds permissions

{id:int}/

Permissions/

GET

Returns information for a specified user on a network.

Segment

id int

A unique identifier for a user

______________________________________________________________

Response

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.

{id:int}/Permissions/DELETE

Removes permissions for a specified user on a network

Segment

id int

A unique identifier for a user

______________________________________________________________

Request Body

An array of Permission entities

_

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 instance

Segment

id int

A unique identifier for a user

______________________________________________________________

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX.

Returns object permissions for a given user instance.

Segment

login string

The login information of the user

Request Body

The User Entity

__________________________________________________________________

Response Body

Response

Success

200: Returns an array of Permission entities

Adds permissions for a specified user on a network

Segment

login string

The login information of the user

______________________________________________________________

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.

Removes permissions

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 network

Segment

loginid int string The login information of the user

A unique identifier for a user

______________________________________________________________

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.

{id:int}/Tokens/{token}/GET

Validates the the user access or refresh token granted to the specified user

Segments

id int

A unique identifier for a user

token string

A user access or refresh token for a BSN.cloud network

______________________________________________________________

Response Body

Returns the Token Info Entity

{id:int}/Tokens/{token}/DELETE

Revokes user access or refresh tokens for the specified user

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 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 operations

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 instance

Segment

id int

A unique identifier for a user

______________________________________________________________

Response

Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX.

Validates the user access or refresh token granted to the specified user

Segments

login int

The login for the user

token string

A user access or refresh token for a BSN.cloud network

______________________________________________________________

Response Body

Returns the Token Info Entity

Revokes the user access or refresh token granted to the specified user

Segments

login int

The login for the user

token string

A user access or refresh token for a BSN.cloud network

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 network

Segment

id int

A unique identifier for a user

______________________________________________________________

Request Body

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX.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 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

Returns object permissions for a given user instance.

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

Adds permissions for a specified user on a network

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

Removes permissions for a specified user on a network

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 user

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 user

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

Validates the user access or refresh token granted to the specified user

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

Revokes the user access or refresh token granted to the specified user

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

Page Comparison

Versions Compared

Old Version 78

New Version 79

Key

GET

Query String Parameters

Response

Success Response Body

Failure

POST

Request Body

Response

Success Response Body

Failure

Endpoints:

{login}/GET

Segment

Response

Success Response with Body

{login}/PUT

Segment

Request Body

Response Body

{login}/DELETE

Success Response

Failure

{login}/PUT

Segment

Response Body

{id:int}/GET

Segment

Request Body

Response

Returns the User Entity

{id:int}/PUT

Segment

Request Body

Response Body

{id:int}/DELETE

Segment

Success

Failure

{login}/DELETE

Segment

Response

Operations/GET

Response Body

{id:int}/Permissions/GET

Segment

Response Body

Success

Success

Failure

{id:int}/

GET

Segment

Response

Request Body

Response Body

{id:int}/Permissions/DELETE

Segment

Request Body

Success Response with Body

Success Response

Failure

{id:int}/PUT

Segment

Response Body

{login}/Permissions/GET

Segment

Request Body

Response

Success

{login}/Permissions/POST

Segment

Request Body

Response Body

{login}/Permissions/DELETE

Failure