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 stringstring 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.

pageSize intThis 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 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.

Returns information for a specified user on a network

Parameters

Segment

login string

The login information of the user

______________________________________________________________

Response Body

Returns the User Entity

Endpoints:

Table of Contents

maxLevel	2
indent	20px
exclude	Endpoints:

Updates information for a specified user on a network

Parameters

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 information for a specified user on a network

Parameters

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.

Parameters

Segment

id int

A unique identifier for a user

______________________________________________________________

Response Body

Returns the User Entity

{id:int}/PUT

Update the given user instance

Parameters

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

Parameters

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

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.

Parameters

Segment

id int

A unique identifier for a user

______________________________________________________________

Response Body

Returns the Permission Entity

{id:int}/Permissions/POST

Adds permissions for a specified user on a network

Parameters

Segment

id int

A unique identifier for a user

______________________________________________________________

Request Body

The Permission Entity

______________________________________________________________

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

Parameters

Segment

id int

A unique identifier for a user

______________________________________________________________

Request Body

The Permission Entity

______________________________________________________________

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.

Parameters

Segment

login string

The login information of the user

______________________________________________________________

Response Body

Returns the Permission Entity

Adds permissions for a specified user on a network

Parameters

Segment

login string

The login information of the user

______________________________________________________________

Request Body

The Permission Entity

______________________________________________________________

Response Body

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

Removes permissions for a specified user on a network

Parameters

Segment

login string

The login information of the user

______________________________________________________________

Request Body

The Permission Entity

______________________________________________________________

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

Parameters

Segments

id int

A unique identifier for a user

token string

A device registration token for a BSN.cloud network

______________________________________________________________

Response Body

Returns the Token Info Entity

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

Revokes tokens for the specified user

Parameters

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.

Validates the specified user's token

Parameters

Segments

login int

The login for the user

token string

A device registration token for a BSN.cloud network

______________________________________________________________

Response Body

Returns the Token Info Entity

Revokes tokens for the specified user

Parameters

Segments

login int

The login for the user

token string

A device registration 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.

Page Comparison

Versions Compared

Old Version 68

New Version 69

Key

GET

Query String Parameters

Response Body

POST

Request Body

Response Body

{login}/GET

Segment

Response Body

Endpoints:

{login}/PUT

Segment

Request Body

Response Body

{login}/DELETE

Segment

Response Body

{id:int}/GET

Segment

Response Body

{id:int}/PUT

Segment

Request Body

Response Body

{id:int}/DELETE

Segment

Response Body

Operations/GET

Response Body

{id:int}/Permissions/GET

Segment

Response Body

{id:int}/Permissions/POST

Segment

Request Body

Response Body

{id:int}/Permissions/DELETE

Segment

Request Body

Response Body

{login}/Permissions/GET

Segment

Response Body

{login}/Permissions/POST

Segment

Request Body

Response Body

{login}/Permissions/DELETE

Segment

Request Body

Response Body

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

Segments

Response Body

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

Segments

Response Body

{login}/Tokens/{token}/GET

Segments

Response Body

{login}/Tokens/{token}/DELETE

Segments

Response Body