This page is in development and as such, its contents may be incorrect

Security model

Aspire 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:

• Administrator
• Operator
• ManagerNode
• WorkerNode

Each REST Endpoint have one of the following security roles associated with them:

• Administrator
  • Only Administrator roles can access the endpoint
• Operator
  • Both Operator and Administrator roles can access the endpoint
• ManagerNode
  • Ony ManagerNode roles can access the endpoint
• WorkerNode
  • Only WorkerNode roles can access the endpoint
• PermitAll
  • Any roles can access the endpoint

Access Tokens

The 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:

{
  "$int_perms": [],
  "sub": "org.pac4j.core.profile.CommonProfile#jdoe",
  "$int_roles": [
    "Administrator"
  ],
  "exp": 1601410068,
  "iat": 1601409768
}

Result JWT Payload fields

Refresh Tokens

Refresh 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.

Login Endpoint

Request

Request Body Parameters

Example

POST /aspire/_api/login
{
  "username": "<username-provided-by-user>",
  "password": "<password-provided-by-user>"
}

Response

Response Body Fields

Example:

{
    "accessToken": "eyJhb...",
    "refreshToken": "eyJhb...",
    "tokenType": "bearer",
    "expiresIn": 300
}

Status

Refresh Endpoint

Request

Request Body Parameters

Example

POST /aspire/_api/login
{
  "refreshToken": "eyJhb..."
}

Response

Response Body Fields

Example:

{
    "accessToken": "eyJhb...",
    "refreshToken": "eyJhb...",
    "tokenType": "bearer",
    "expiresIn": 300
}

Status