RIrilldata

IssueUserAuthToken issues an access token for the current user. You can optionally pass "current" instead of the user ID to issue a token for the current user.

post/v1/users/{userId}/tokens

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

userIdstring required

User ID to issue the auth token for. Set to "current" to issue an auth token for the current user.

Request body

clientIdstring

Client ID to issue the token for.

displayNamestring

Optional display name for the auth token.

representEmailstring

Optional email of another user to assume the identity of. This is only allowed for superusers.

superuserForceAccessboolean

Flag for superusers to override normal access checks.

ttlMinutesstring int64

Optional TTL for the auth token in minutes. Set to 0 for no expiry. Defaults to no expiry.

Response

A successful response.

tokenstring

Newly issued auth token.

Changes

No recorded changes to this operation across all 70 revisions of this API.