Users Endpoints (2017/01)

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.brightsignnetwork.com/2017/01/REST/Users

GET  /

Returns a list of user instances on a network

Parameters

marker  string

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 int

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.

GET  /{login}/ 

Returns information for a specified user on a network

Parameters

login string

The login information of the user

______________________________________________________________

Response Body

Returns the User Entity

PUT  /{login}/ 

Updates information for a specified user on a network

Parameters

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.

DELETE  /{login}/ 

Deletes information for a specified user on a network

Parameters

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.

GET  /{id:int}/ 

Returns information for a specified user on a network.

Parameters

id int

A unique identifier for a user

______________________________________________________________

Response Body

Returns the User Entity

PUT  /{id:int}/ 

Update the given user instance

Parameters

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.

DELETE  /{id:int}/ 

Deletes information for a specified user on a network

Parameters

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

GET  /Operations/ 

Returns the operational permissions granted to roles for specific business operations

Response Body

Returns the Business Operations Entity

GET  /{id:int}/Permissions/ 

Includes object permissions for a given user instance.

Parameters

id int

A unique identifier for a user

______________________________________________________________

Response Body

Returns the Permission Entity

POST  /{id:int}/Permissions/ 

Adds permissions for a specified user on a network

Parameters

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.

DELETE  /{id:int}/Permissions/ 

Removes permissions for a specified user on a network

Parameters

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.

GET  /{login}/Permissions/ 

Includes object permissions for a given user instance.

Parameter

login string

The login information of the user

______________________________________________________________

Response Body

Returns the Permission Entity

POST  /{login}/Permissions/ 

Adds permissions for a specified user on a network

Parameter

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.

DELETE  /{login}/Permissions/ 

Removes permissions for a specified user on a network

Parameter

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.