Users Endpoints (2020/10)

Owned by BrightSign TechDocs
Last updated: Jul 10, 2023
9 min read

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

Required Scope Token

bsn.api.main.users.retrieve

______________________________________________________________

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

Required Scope Token

bsn.api.main.users.create

______________________________________________________________

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

 

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

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

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

______________________________________________________________

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

______________________________________________________________

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

 

POST /{login}/Permissions/ 

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

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 /{login}/Permissions/ 

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

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

______________________________________________________________

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

 

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

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

 

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

______________________________________________________________

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

 

DELETE /{login}/Tokens/{token}/ 

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

Required Scope Token

bsn.api.main.users.token.revoke

______________________________________________________________

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