| Expand | ||||||
|---|---|---|---|---|---|---|
| ||||||
|
BrightSign API structures operations and services are based on the REST principles. This approach allows you to group your data by resources, and for each resource, define a list of operations. The REST style is commonly used for create, read, update, and delete (crud) operations.
...
Response Body
access_token string: The authorization token to use with endpoint calls until half of the expires_in time period has elapsed
token_type string: The OAuth 2.0 token type, which will always be returned as "bearer"
expires_in integer: The lifetime (in seconds) of the authorization token
refresh_token string: The token to use for re-authentication when more than half of the expires_in time period has elapsed.
scope string[]: 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.
userLogin string: The username included in the request body
userId integer: The user identifier, which may be used in subsequent requests. This entry is only returned for User Authentication Requests.
personId integer: The person identifier
networkNames string[]: 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.
.issued string: The date and time the authorization/refresh token was issued (formatted as "[3-letter weekday], dd mmm yyyy hh:mm:ss [3-letter timezone]")
.expires string: The date and time the authorization/refresh token expires (formatted as "[3-letter weekday], dd mmm yyyy hh:mm:ss [3-letter timezone]")
...