Roles Endpoints (2020/10)
- BrightSign TechDocs
These endpoints allow users to manage roles on a network.
Base URL for these endpoints: https://api.bsn.cloud/2020/10/REST/Roles
_________________________________________________________________________
GET /
Returns a list of roles on a network
Required Scope Token
bsn.api.main.roles.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 role 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 role 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 Role 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 role on a network
Required Scope Token
bsn.api.main.roles.create
______________________________________________________________
Request Body
The Role Entity
______________________________________________________________
Response
Success Response Body
201: Returns the Role 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 /{id:int}/
Returns a specified role on a network
Required Scope Token
bsn.api.main.roles.retrieve
______________________________________________________________
Segment
id int
A unique identifier for a role instance
______________________________________________________________
Response
Success Response with Body
200: Returns the Role 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}/
Updates a role on a network
Required Scope Token
bsn.api.main.roles.update
______________________________________________________________
Segment
id int
A unique identifier for a role instance
______________________________________________________________
Request Body
The Role Entity
______________________________________________________________
Response
Success
204: The role was successfully 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}/
Removes a role on a network
Required Scope Token
bsn.api.main.roles.delete
______________________________________________________________
Segment
id int
A unique identifier for a role instance
______________________________________________________________
Response
Success
204: The specified role has been removed
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 /{name}/
Returns a specified role on a network
Required Scope Token
bsn.api.main.roles.retrieve
______________________________________________________________
Segment
name string
The name of the role instance
______________________________________________________________
Response
Success Response with Body
200: Returns the Role 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 /{name}/
Updates a role on a network
Required Scope Token
bsn.api.main.roles.update
______________________________________________________________
Segment
name string
The name of the role instance
______________________________________________________________
Request Body
The Role Entity
______________________________________________________________
Response
Success
204: The role was successfully 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 /{name}/
Removes a role from a network
Required Scope Token
bsn.api.main.roles.delete
______________________________________________________________
Segment
name string
The name of the role instance
______________________________________________________________
Response
Success
204: The specified role has been removed
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 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 role instance.
Required Scope Token
bsn.api.main.roles.retrieve
______________________________________________________________
Segment
id int
A unique identifier for a role
______________________________________________________________
Response
Success Response Body
200: Returns an array of Permission entities granted to a given role
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/
Add permissions for specified roles on a network
Required Scope Token
bsn.api.main.roles.update
______________________________________________________________
Segment
id int
A unique identifier for a role
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
Response
Success
204: The permissions were successfully added to the specified role
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 specified roles on a network
Required Scope Token
bsn.api.main.roles.delete
______________________________________________________________
Segment
id int
A unique identifier for a role
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
Response
Success
204: The specified permissions have been removed from the role
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 /{name}/Permissions/
Returns object permissions for a given role instance.
Required Scope Token
bsn.api.main.roles.retrieve
______________________________________________________________
Segment
name string
The name of the role
______________________________________________________________
Response
Success Response Body
200: Returns an array of Permission entities granted to a given role
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 /{name}/Permissions/
Add permissions for specified roles on a network
Required Scope Token
bsn.api.main.roles.update
______________________________________________________________
Segment
name string
The name of the role
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
Response
Success
204: The permissions were successfully added to the specified role
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 /{name}/Permissions/
Removes permissions for specified role on a network
Required Scope Token
bsn.api.main.roles.delete
______________________________________________________________
Segment
name string
The name of the role
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
Response
Success
204: The specified permissions have been removed from the role
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