Skip to main content

Mint a token for a person​

This endpoint creates a token for a specific user.

Custom claims can be specified in the request body which will be added to the token's payload. Custom claims are added to the token's payload.

Tokens created with this endpoint will have an authenticated_methods claim equal to ["api"].

The following claims are reserved and cannot be specified:

  • aud
  • exp
  • jti
  • iat
  • iss
  • nbf
  • sub
  • prev_token_id
  • oid
  • org_id
  • user_id
  • person_id
  • first_token
  • authenticated_methods
  • oidc_tokens
  • user_token
  • groups
  • roles
  • access_token
  • refresh_token
  • id
  • id_token
  • gdpr
  • gdpr_consent
  • gdpr_consent_level
  • parent_user_id
  • parent_person_id
  • parent_org_id
  • parent_oid
  • attributes
  • custom_claims
  • slashid
  • slashid.dev
  • slashid.com
  • slashid.me
  • sid

With the following request body:

{
    "custom_claims": {
        "foo": "bar",
        "baz": {"everything": 42}
    }
}

the token in the response will have the following payload:

{
  "authenticated_methods": [
    "api"
  ],
  "baz": {
    "everything": 42
  },
  "exp": <expiration time timestamp>,
  "first_token": false,
  "foo": "bar",
  "iat": <issued at timestamp>,
  "iss": <token issuer>,
  "jti": <token ID>,
  "oid": <organisation ID>,
  "person_id": <person ID>
}
Path Parameters
  • person_id string required

    The person ID

    Example: 903c1ff9-f2cc-435c-b242-9d8a690fcf0a
Header Parameters
  • SlashID-OrgID string required

    The organization ID

    Example: af5fbd30-7ce7-4548-8b30-4cd59cb2aba1
Request Body required
  • custom_claims object

    Set of custom claims to be added to the JWT payload, as key-value pairs.

Responses

The result string is a newly-minted SlashID token.

Schema
  • meta object
  • pagination object
  • limit integer
  • offset integer
  • total_count int64
  • cursor_pagination object

    Cursors are opaque. Follow the tokens the server returns; never construct, parse or modify one.

  • limit integer
  • next_cursor string

    Opaque token addressing the next page. Absent on the last page.

  • prev_cursor string

    Opaque token addressing the previous page. Absent on the first page.

  • last_cursor string

    Opaque token addressing the final page directly, so a client can jump to the end without a total count.

  • total_count int64

    Total number of matching items. Returned on the FIRST page only; clients cache it for the remainder of the walk.

  • errors object[]
  • httpcode integer
  • message string
  • result string