Users Endpoints (2020/10)

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

/Users/

GET

Returns a list of user instances on a network

Parameters

  • [string] marker: 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.
  • [int] pageSize: The maximum number of user instances that can be contained in the response body

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.

/Users/{login}/

GET

Returns information for a specified user on a network

Parameters

  • [string] login: The login information of the user

Response Body

Returns the User Entity

ON THIS PAGE


PUT

Updates information for a specified user on a network

Parameters

  • [string] login: 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.

DELETE

Deletes information for a specified user on a network

Parameters

  • [string] login: 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.

/Users/{id:int}/

GET

Returns information for a specified user on a network.

Parameters

  • [int] id: A unique identifier for a user

Response Body

Returns the User Entity

PUT

Update the given user instance

Parameters

  • [int] id: 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.

DELETE

Deletes information for a specified user on a network

Parameters

  • [int] id: 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

/Users/Operations/

GET

Returns the operational permissions granted to roles for specific business operations

Response Body

Returns the Business Operations Entity

/Users/{id:int}/Permissions/

GET

Includes object permissions for a given user instance.

Parameters

  • [int] id: A unique identifier for a user

Response Body

Returns the Permission Entity

POST

Adds permissions for a specified user on a network

Parameters

  • [int] id: 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.

DELETE

Removes permissions for a specified user on a network

Parameters

  • [int] id: 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.

/Users/{login}/Permissions/

GET

Includes object permissions for a given user instance.

Parameters

  • [string] login: The login information of the user

Response Body

Returns the Permission Entity

POST

Adds permissions for a specified user on a network

Parameters

  • [string] loginThe 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.

DELETE

Removes permissions for a specified user on a network

Parameters

  • [string] loginThe 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.

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

GET

Validates the specified user's token

Parameters

  • [int] id: A unique identifier for a user
  • [string] token: A device registration token for a BSN.cloud network

Response Body

Returns the Token Info Entity

DELETE

Revokes tokens for the specified user

Parameters

  • [int] id: A unique identifier for a user
  • [string] token: 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.

/Users/{login}/Tokens/{token}/

GET

Validates the specified user's token

Parameters

  • [string] login: The login for the user
  • [string] token: A device registration token for a BSN.cloud network

Response Body

Returns the Token Info Entity

DELETE

Revokes tokens for the specified user

Parameters

  • [stringlogin: The login for the user
  • [string] token:  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.