Versions Compared

Old Version 16

changes.mady.by.user BrightSign TechDocs

Saved on

compared with

New Version 17

changes.mady.by.user BrightSign TechDocs

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
borderColor#3D3D3D
bgColor#F4F4F4
titleColor#3D3D3D
borderWidth0
titleBGColor#3D3D3D
borderStylesolid

ON THIS PAGE

Table of Contents
indent20px

...

Note
titleNote

The expires_in value may be changed on the server at any time, or it may be randomized on each authentication return. Therefore, the token expiration time should not be hardcoded on the client application; the application should store the expires_in value along with the Access/Refresh token and calculate a new token-refresh interval on every return.

/token

POST

Posts user credentials or a refresh token to the /token endpoint. If the credentials are valid, the server returns an access/refresh token that is included with all other BSN REST calls for authentication.

Note
titleNote

Unlike other BSN REST endpoints, the /token endpoint does not accept a trailing slash. 

...

Request Body

  • username: The BSN username. If this is a User Authentication Request, the network name preceeds the username (e.g. "exampleNetwork/exampleUser@brightsign.biz").
  • password: The password associated with the username.
  • network: The network to which the returned token should grant access. This entry can can be used for either the initial User Authentication Request, or to switch to another network to which the user belongs upon token renewal.
  • grant_type: The type of grant being presented in exchange for the access token. This value must be set to "password".
  • client_id: The client identifier. This value is currently not used by the server.
  • client_secret: The client secret. This value is currently not used by the server.
  • refresh_token: The refresh token to include when renewing the access token. When the refresh_token entry is included, the password does not need to be used.

...

  • [string] access_token: The authorization token to use with endpoint calls until half of the expires_in time period has elapsed
  • [string] token_type: The OAuth 2.0 token type, which will always be returned as "bearer"
  • [integer] expires_in: The lifetime (in seconds) of the authorization token
  • [string] refresh_token: The token to use for re-authentication when more than half of the expires_in time period has elapsed.
  • [string[]]scope: An array that lists the scope granted by the token. A successful Person Authentication Response will include the "Self" value only, while a successful User Authentication Response will contain both "Full" and "Self" values. 
  • [string] userLogin: The username included in the request body
  • [integer] userId: The user identifier, which may be used in subsequent requests. This entry is only returned for User Authentication Requests.
  • [integer] personId: The person identifier
  • [string[]] networkNames: An array of networks to which the person (i.e. the account associated with the login credentials) belongs. This entry is only returned for Person Authentication requests.
  • [string] .issued: The date and time the authorization/refresh token was issued (formatted as "[3-letter weekday], dd mmm yyyy hh:mm:ss [3-letter timezone]")
  • [string] .expires: The date and time the authorization/refresh token expires (formatted as "[3-letter weekday], dd mmm yyyy hh:mm:ss [3-letter timezone]")

Examples

Person Authentication Request

...