Create a new API Token

POST /environments/{environmentId}/tokens

Try it

Create a new API Token

cURL

curl --request POST \
  --url https://app.dynamicauth.com/api/v0/environments/{environmentId}/tokens \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "note": "<string>",
  "scopes": [
    "waas.delegatedAccess.signMessage"
  ]
}
'

201

{
  "token": {
    "id": "95b11417-f18f-457f-8804-68e361f9164f",
    "rawToken": "dyn_aGLjTe3TUN40vSE75sTtgUx9AjIe0q4n3LFC",
    "checksum": "4n3LFC",
    "createdBy": {
      "id": "95b11417-f18f-457f-8804-68e361f9164f",
      "alias": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "[e-mail]"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "active": true,
    "note": "<string>",
    "projectEnvironmentId": "95b11417-f18f-457f-8804-68e361f9164f",
    "projectEnvironment": {
      "id": "95b11417-f18f-457f-8804-68e361f9164f"
    },
    "scopes": [
      "waas.delegatedAccess.signMessage"
    ]
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

environmentId · string · required

ID of the environment

Required string length: 36

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Body

application/json

Fields necessary to create a new token

Environment API token required fields for creation.

note · string · required

Name or note to help identify this token and its use.

Maximum string length: 100

scopes · enum<string>[]

Scopes assigned to an API token which they will have access to.

Valid scopes for an environment API token

Available options: waas.delegatedAccess.signMessage, waas.authenticate, environment.settings.read, environment.settings.write, environment.apiTokens.read, environment.apiTokens.write, environment.users.read, environment.users.write, environment.analytics.read, environment.webhooks.read, environment.webhooks.write, environment.events.read, environment.events.write, environment.balances.read

Response

201

application/json

The token that has been created, including the plaintext of the token

token · object · required

Show child attributes

token. id · string · required

Required string length: 36

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

token. rawToken · string · required

The actual token created. If you do not save it, it can never be retrieved again

Example:

"dyn_aGLjTe3TUN40vSE75sTtgUx9AjIe0q4n3LFC"

token. checksum · string · required

A 6-character alpha-numeric string checksum of the random API Token. The last 6 characters of the raw token

Example:

"4n3LFC"

token. createdBy · object · required

Show child attributes

token.createdBy. id · string · required

Required string length: 36

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

token.createdBy. alias · string

token.createdBy. firstName · string

token.createdBy. lastName · string

token.createdBy. email · string<email>

token. createdAt · string<date-time> · required

token. active · boolean

Only active tokens can be used.

Example:

true

token. note · string

token. projectEnvironmentId · string

Required string length: 36

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

token. projectEnvironment · object

Show child attributes

token.projectEnvironment. id · string

Required string length: 36

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

token. scopes · enum<string>[]

Scopes assigned to an API token which they will have access to.

Valid scopes for an environment API token

Available options: waas.delegatedAccess.signMessage, waas.authenticate, environment.settings.read, environment.settings.write, environment.apiTokens.read, environment.apiTokens.write, environment.users.read, environment.users.write, environment.analytics.read, environment.webhooks.read, environment.webhooks.write, environment.events.read, environment.events.write, environment.balances.read