Token Management

View as Markdown

Get token infoGET /api/2.0/token-management/tokens/{token_id}List all tokensGET /api/2.0/token-management/tokensUpdate an on-behalf tokenPATCH /api/2.0/token-management/tokens/{token_id}Delete a tokenDELETE /api/2.0/token-management/tokens/{token_id}Create on-behalf tokenPOST /api/2.0/token-management/on-behalf-of/tokens

AdminTokenInfo object

token_idstring

ID of the token.

Example: 5684c955822ac792a51ae2aeb80190f13457bab3e2e2934c133a08b38454816c

creation_timeint64

Timestamp when the token was created.

Example: 1580265020299

expiry_timeint64

Timestamp when the token expires.

Example: 1580265020299

commentstring

Comment that describes the purpose of the token, specified by the token creator.

Example: This is for the ABC department automation scripts.

created_by_idint64

User ID of the user that created the token.

Example: 202480738464078

created_by_usernamestring

Username of the user that created the token.

Example: jsmith@example.com

owner_idint64

User ID of the user that owns the token.

Example: 202480738464078

workspace_idint64

If applicable, the ID of the workspace that the token was created in.

Example: 5750939285643220

last_used_dayint64

Approximate timestamp for the day the token was last used. Accurate up to 1 day.

Example: 1710374400000

scopesarray of stringGA

Scope of the token was created with, if applicable.

View as Markdown

The AdminTokenInfo object

{
  "token_id": "5684c955822ac792a51ae2aeb80190f13457bab3e2e2934c133a08b38454816c",
  "creation_time": 1580265020299,
  "expiry_time": 1580265020299,
  "comment": "This is for the ABC department automation scripts.",
  "created_by_id": 202480738464078,
  "created_by_username": "jsmith@example.com",
  "owner_id": 202480738464078,
  "workspace_id": 5750939285643220,
  "last_used_day": 1710374400000,
  "scopes": [
    "string"
  ]
}

Get token info GA

GET /api/2.0/token-management/tokens/{token_id}

Gets information about a token, specified by its ID.

API scopes: authentication

Parameters

token_idstringRequiredpath

The ID of the token to get.

Response

token_infoobject

Show child attributesHide child attributes

token_idstring

ID of the token.

Example: 5684c955822ac792a51ae2aeb80190f13457bab3e2e2934c133a08b38454816c

creation_timeint64

Timestamp when the token was created.

Example: 1580265020299

expiry_timeint64

Timestamp when the token expires.

Example: 1580265020299

commentstring

Comment that describes the purpose of the token, specified by the token creator.

Example: This is for the ABC department automation scripts.

created_by_idint64

User ID of the user that created the token.

Example: 202480738464078

created_by_usernamestring

Username of the user that created the token.

Example: jsmith@example.com

owner_idint64

User ID of the user that owns the token.

Example: 202480738464078

workspace_idint64

If applicable, the ID of the workspace that the token was created in.

Example: 5750939285643220

last_used_dayint64

Approximate timestamp for the day the token was last used. Accurate up to 1 day.

Example: 1710374400000

scopesarray of string

Scope of the token was created with, if applicable.

View as Markdown

Response

{
  "token_info": {
    "token_id": "5684c955822ac792a51ae2aeb80190f13457bab3e2e2934c133a08b38454816c",
    "creation_time": 1580265020299,
    "expiry_time": 1580265020299,
    "comment": "This is for the ABC department automation scripts.",
    "created_by_id": 202480738464078,
    "created_by_username": "jsmith@example.com",
    "owner_id": 202480738464078,
    "workspace_id": 5750939285643220,
    "last_used_day": 1710374400000,
    "scopes": [
      "string"
    ]
  }
}

List all tokens GA

GET /api/2.0/token-management/tokens

Lists all tokens associated with the specified workspace or user.

API scopes: authentication

Parameters

created_by_idint64query

User ID of the user that created the token.

created_by_usernamestringquery

Username of the user that created the token.

Response

Returns a list of AdminTokenInfo objects.

View as Markdown

Response

{
  "token_infos": [
    {
      "token_id": "5684c955822ac792a51ae2aeb80190f13457bab3e2e2934c133a08b38454816c",
      "creation_time": 1580265020299,
      "expiry_time": 1580265020299,
      "comment": "This is for the ABC department automation scripts.",
      "created_by_id": 202480738464078,
      "created_by_username": "jsmith@example.com",
      "owner_id": 202480738464078,
      "workspace_id": 5750939285643220,
      "last_used_day": 1710374400000,
      "scopes": [
        "string"
      ]
    }
  ]
}

Update an on-behalf token GA

PATCH /api/2.0/token-management/tokens/{token_id}

Updates a token, specified by its ID.

API scopes: authentication

Parameters

token_idstringRequiredpath

ID of the token.

Example: 5684c955822ac792a51ae2aeb80190f13457bab3e2e2934c133a08b38454816c

Request body

tokenobjectRequired

Show child attributesHide child attributes

creation_timeint64

Timestamp when the token was created.

Example: 1580265020299

expiry_timeint64

Timestamp when the token expires.

Example: 1580265020299

commentstring

Comment that describes the purpose of the token, specified by the token creator.

Example: This is for the ABC department automation scripts.

created_by_idint64

User ID of the user that created the token.

Example: 202480738464078

created_by_usernamestring

Username of the user that created the token.

Example: jsmith@example.com

owner_idint64

User ID of the user that owns the token.

Example: 202480738464078

workspace_idint64

If applicable, the ID of the workspace that the token was created in.

Example: 5750939285643220

last_used_dayint64

Approximate timestamp for the day the token was last used. Accurate up to 1 day.

Example: 1710374400000

scopesarray of string

Scope of the token was created with, if applicable.

update_maskstringRequired

A list of field name under token, For example, {"update_mask": "comment,scopes"}

Response

Returns the AdminTokenInfo object.

View as Markdown

Request

{
  "token": {
    "creation_time": 1580265020299,
    "expiry_time": 1580265020299,
    "comment": "This is for the ABC department automation scripts.",
    "created_by_id": 202480738464078,
    "created_by_username": "jsmith@example.com",
    "owner_id": 202480738464078,
    "workspace_id": 5750939285643220,
    "last_used_day": 1710374400000,
    "scopes": [
      "string"
    ]
  },
  "update_mask": "string"
}

Response

{
  "token_id": "5684c955822ac792a51ae2aeb80190f13457bab3e2e2934c133a08b38454816c",
  "creation_time": 1580265020299,
  "expiry_time": 1580265020299,
  "comment": "This is for the ABC department automation scripts.",
  "created_by_id": 202480738464078,
  "created_by_username": "jsmith@example.com",
  "owner_id": 202480738464078,
  "workspace_id": 5750939285643220,
  "last_used_day": 1710374400000,
  "scopes": [
    "string"
  ]
}

Delete a token GA

DELETE /api/2.0/token-management/tokens/{token_id}

Deletes a token, specified by its ID.

API scopes: authentication

Parameters

token_idstringRequiredpath

The ID of the token to revoke.

View as Markdown

Response

{}

Create on-behalf token GA

POST /api/2.0/token-management/on-behalf-of/tokens

Creates a token on behalf of a service principal.

API scopes: authentication

CloudsAWSGCP

Request body

application_idstringRequired

Application ID of the service principal.

Example: 6f5ccf28-d83a-4957-9bfb-5bbfac551410

lifetime_secondsint64

The number of seconds before the token expires.

Example: 3600

commentstring

Comment that describes the purpose of the token.

Example: This is for the ABC department automation scripts.

scopesarray of string

Response

token_valuestring

Value of the token.

token_infoobject

Show child attributesHide child attributes

token_idstring

ID of the token.

Example: 5684c955822ac792a51ae2aeb80190f13457bab3e2e2934c133a08b38454816c

creation_timeint64

Timestamp when the token was created.

Example: 1580265020299

expiry_timeint64

Timestamp when the token expires.

Example: 1580265020299

commentstring

Comment that describes the purpose of the token, specified by the token creator.

Example: This is for the ABC department automation scripts.

created_by_idint64

User ID of the user that created the token.

Example: 202480738464078

created_by_usernamestring

Username of the user that created the token.

Example: jsmith@example.com

owner_idint64

User ID of the user that owns the token.

Example: 202480738464078

workspace_idint64

If applicable, the ID of the workspace that the token was created in.

Example: 5750939285643220

last_used_dayint64

Approximate timestamp for the day the token was last used. Accurate up to 1 day.

Example: 1710374400000

scopesarray of string

Scope of the token was created with, if applicable.

View as Markdown

Request

{
  "application_id": "6f5ccf28-d83a-4957-9bfb-5bbfac551410",
  "lifetime_seconds": 3600,
  "comment": "This is for the ABC department automation scripts.",
  "scopes": [
    "string"
  ]
}

Response

{
  "token_value": "string",
  "token_info": {
    "token_id": "5684c955822ac792a51ae2aeb80190f13457bab3e2e2934c133a08b38454816c",
    "creation_time": 1580265020299,
    "expiry_time": 1580265020299,
    "comment": "This is for the ABC department automation scripts.",
    "created_by_id": 202480738464078,
    "created_by_username": "jsmith@example.com",
    "owner_id": 202480738464078,
    "workspace_id": 5750939285643220,
    "last_used_day": 1710374400000,
    "scopes": [
      "string"
    ]
  }
}