Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 73 Next »

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 specified representation of the user entity is not acceptable

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:


{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

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

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

______________________________________________________________

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

______________________________________________________________

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

The Permission Entity

______________________________________________________________

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 Body

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 

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.

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

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

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.

{login}/Tokens/{token}/GET

Validates the specified user's token

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

{login}/Tokens/{token}/DELETE

Revokes tokens for the specified user

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.





  • No labels