Miscellaneous / Auth /

Get current authentication info

Returns details about the authentication material used in this request.

Response body

{object}
Response object.

data
{object} required
Result data.

tokenKind
string required
The type of authentication material used for the request.
one of
api, session
id
string required
The API token ID (slug) or session token UUID.
name
string
The API token name or session token label, if set.
description
string
The description of the API token, if API token authentication was used.
entityId
string required
The ID (slug) of the entity this authentication material is scoped to.
entityUid
string required
The object ID of the entity this authentication material is scoped to.
entityType
string required
The type of entity this authentication material is scoped to.
one of
team, org
orgId
string
The ID (slug) of the organisation, if the entity is an org-owned team.
orgUid
string
The object ID of the organisation, if the entity is an org-owned team.
role
{object}
The role assigned to the API token, if API token authentication was used.

name
string
The display name of the role.
roleId
string
The ID (slug) of the role.
roleType
string
The type of the role.
one of
team, org
entityType
string required
The entity type of the role.
one of
team, org

permissions
{object}
The effective permissions granted to this authentication material.

orgScope
[array]
Organisation-level permission strings.

string

teamScope
[array]
Team-level permission strings.

string

projectScope
[array]
Project-level permission strings.

string

creatorEmail
string
The email of the user who created the API token.
createdAt
string required
The time the authentication material was created.
expiresAt
string | null
The time the authentication material expires, or null if it has no expiry.

API

CLI

JS Client

GET /v1/auth

Example response

200 OK

Details about the current authentication.

JSON

{
  "data": {
    "tokenKind": "api",
    "id": "my-api-token",
    "name": "My API Token",
    "description": "CI/CD pipeline token",
    "entityId": "my-team",
    "entityUid": "507f1f77bcf86cd799439011",
    "entityType": "team",
    "orgId": "my-org",
    "orgUid": "507f191e810c19729de860ea",
    "role": {
      "name": "Developer",
      "roleId": "developer",
      "roleType": "team",
      "entityType": "team"
    },
    "creatorEmail": "user@example.com",
    "createdAt": "2024-01-15T10:30:00.000Z",
    "expiresAt": "2024-07-15T10:30:00.000Z"
  }
}