Auth

Create a new API token (email + password)

Authenticates the user with Devise email/password and returns a freshly issued raw API token. The raw token is returned ONCE; only its prefix and metadata are retrievable afterwards.

post/api/v1/tokens

Request

  • Base URL: https://getscaleforge.com
  • URL: https://getscaleforge.com/api/v1/tokens
  • Auth: none required

Request body

emailstring email required
passwordstring password required
namestring
scopesstring[]

Subset of UserApiToken::VALID_SCOPES

Example request

{
  "email": "user@example.com",
  "password": "s3cret!",
  "name": "My CLI Token",
  "scopes": [
    "creatives:read",
    "campaigns:read",
    "analytics:read"
  ]
}

Response

Token issued

tokenstring

Raw token, shown only once

idinteger
namestring
prefixstring
scopesstring[]
created_atstring date-time

Example response

{
  "token": "sf_abc123xyz...",
  "id": 42,
  "name": "My CLI Token",
  "prefix": "sf_abcd"
}

Changes

No recorded changes to this operation across all 1 revision of this API.