Warning | ||
---|---|---|
| ||
This page is in development and as such, its contents may be incorrect |
The security API provides the functionality for obtaining and refreshing the tokens needed for interacting with all Configuration API, Worker Node API and Manager Node API.
Table of Contents |
---|
Section |
---|
Security modelAspire can be configured to restrict the REST APIs so that they only can be accessed through the use of authentication tokens. Any given user or Aspire node must posses a valid authentication token before executing any secured REST API. Any user or Aspire node will be assigned with a role definition that specifies the level of access to the different REST endpoints, as some endpoints might be restricted to certain roles. The current existing roles are:
Each REST Endpoint have one of the following security roles associated with them:
|
Section | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Access TokensThe access tokens are JWT tokens, signed with HS256 algorithm. These tokens are either auto-generated by the Aspire nodes, or requested via the /login endpoint. An example of the JWT Payload generated for the jdoe user looks like this:
Result fields
|
Section |
---|
Refresh TokensRefresh tokens are used to obtain a new valid Access Token when the one previously generated is expired. The refresh tokens also expires, but they usually are configured to live longer than their access token counterpart. The Aspire refresh tokens are just other JWT tokens generated with longer expiration time. Look at the /refresh endpoint for details on how to use them to obtain a new Access Token. |
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Login Endpoint
RequestRequest Body Parameters
Example
ResponseResponse Body Fields
Example:
Status
|
Section | |||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Section | Refresh Endpoint
RequestRequest Body Parameters
Example
ResponseResponse Body Fields
Example:
Status
|