Skip to content

Personal access tokens for programmatic access with the member's own permissions, including organization-wide token administration.

GET/me/tokens

List my personal access tokens

Returns a paginated list of the currently authenticated member's personal access tokens, including expired tokens. Deleted tokens are not returned. Token secrets are not included in the response.

Parameters

limitinteger
limit

The maximum number of items to list.

Type
integer
Format
"int32"
Minimum
0
Maximum
100
Default
100
markerstring
marker

The pagination token returned from the previous list operation.

Type
string
Responses

Responses​

A list of personal access tokens is returned.

application/json
JSON
{
  
"items": [
  
  
{
  
  
  
"id": "A1B2C3D4E5",
  
  
  
"memberId": "A1B2C3D4E5",
  
  
  
"name": "string",
  
  
  
"description": "string",
  
  
  
"expiresAt": "string",
  
  
  
"revokedAt": "string",
  
  
  
"revokedBy": "A1B2C3D4E5",
  
  
  
"revokedReason": "string",
  
  
  
"lastRegeneratedAt": "string",
  
  
  
"lastUsedAt": "string",
  
  
  
"createdAt": "string",
  
  
  
"createdBy": "A1B2C3D4E5",
  
  
  
"updatedAt": "string",
  
  
  
"updatedBy": "A1B2C3D4E5"
  
  
}
  
],
  
"marker": "string"
}
POST/me/tokens

Create a personal access token

Creates a new personal access token for the currently authenticated member. The token acts as the member and carries the member's permissions. The token secret is returned only once in the response and cannot be retrieved later. An expiry is required and must not exceed the organization's maximum token lifetime. Creating a token requires recent interactive authentication.

Request Body​

application/json
JSON
{
  
"name": "string",
  
"description": "string",
  
"expiresAt": "string"
}
Responses

Responses​

The personal access token was created successfully.

application/json
JSON
{
  
"id": "A1B2C3D4E5",
  
"memberId": "A1B2C3D4E5",
  
"name": "string",
  
"description": "string",
  
"expiresAt": "string",
  
"token": "string",
  
"revokedAt": "string",
  
"revokedBy": "A1B2C3D4E5",
  
"revokedReason": "string",
  
"lastRegeneratedAt": "string",
  
"lastUsedAt": "string",
  
"createdAt": "string",
  
"createdBy": "A1B2C3D4E5",
  
"updatedAt": "string",
  
"updatedBy": "A1B2C3D4E5"
}
GET/me/tokens/{tokenId}

Describe a personal access token

Returns the information about one of the currently authenticated member's personal access tokens. Deleted tokens are not found. The token secret is not included in the response.

Responses

Responses​

The information about the personal access token is returned.

application/json
JSON
{
  
"id": "A1B2C3D4E5",
  
"memberId": "A1B2C3D4E5",
  
"name": "string",
  
"description": "string",
  
"expiresAt": "string",
  
"revokedAt": "string",
  
"revokedBy": "A1B2C3D4E5",
  
"revokedReason": "string",
  
"lastRegeneratedAt": "string",
  
"lastUsedAt": "string",
  
"createdAt": "string",
  
"createdBy": "A1B2C3D4E5",
  
"updatedAt": "string",
  
"updatedBy": "A1B2C3D4E5"
}
DELETE/me/tokens/{tokenId}

Delete a personal access token

Deletes one of the currently authenticated member's personal access tokens. The token immediately stops working and no longer appears in the member's token list. Organization administrators can still see recently deleted tokens until they are purged after the retention period.

Responses

Responses​

The requested operation was done successfully.

POST/me/tokens/{tokenId}/regenerate

Regenerate a personal access token

Replaces the secret of one of the currently authenticated member's personal access tokens. The old secret immediately stops working. The new secret is returned only once in the response and cannot be retrieved later. A new expiry is required and must not exceed the organization's maximum token lifetime. Regenerating a token requires recent interactive authentication.

Request Body​

application/json
JSON
{
  
"expiresAt": "string"
}
Responses

Responses​

The personal access token was regenerated successfully.

application/json
JSON
{
  
"id": "A1B2C3D4E5",
  
"memberId": "A1B2C3D4E5",
  
"name": "string",
  
"description": "string",
  
"expiresAt": "string",
  
"token": "string",
  
"revokedAt": "string",
  
"revokedBy": "A1B2C3D4E5",
  
"revokedReason": "string",
  
"lastRegeneratedAt": "string",
  
"lastUsedAt": "string",
  
"createdAt": "string",
  
"createdBy": "A1B2C3D4E5",
  
"updatedAt": "string",
  
"updatedBy": "A1B2C3D4E5"
}
GET/org/tokens

List the organization's personal access tokens

Returns a paginated list of the personal access tokens in the organization, optionally filtered by owning member. Token secrets are never included in the response.

Parameters

memberIdstring
memberId

Filter by the member owning the tokens.

Type
string
Example"A1B2C3D4E5"
Min Length
1
Max Length
20
Pattern
"^[A-Z0-9]{1,20}$"
limitinteger
limit

The maximum number of items to list.

Type
integer
Format
"int32"
Minimum
0
Maximum
100
Default
100
markerstring
marker

The pagination token returned from the previous list operation.

Type
string
Responses

Responses​

A list of personal access tokens is returned.

application/json
JSON
{
  
"items": [
  
  
{
  
  
  
"id": "A1B2C3D4E5",
  
  
  
"memberId": "A1B2C3D4E5",
  
  
  
"name": "string",
  
  
  
"description": "string",
  
  
  
"expiresAt": "string",
  
  
  
"revokedAt": "string",
  
  
  
"revokedBy": "A1B2C3D4E5",
  
  
  
"revokedReason": "string",
  
  
  
"lastRegeneratedAt": "string",
  
  
  
"lastUsedAt": "string",
  
  
  
"createdAt": "string",
  
  
  
"createdBy": "A1B2C3D4E5",
  
  
  
"updatedAt": "string",
  
  
  
"updatedBy": "A1B2C3D4E5"
  
  
}
  
],
  
"marker": "string"
}
GET/org/tokens/summaries

List per-member personal access token summaries

Returns paginated, server-computed personal access token aggregates per member of the organization: active token count, nearest expiry, and most recent use. Members without tokens are not included.

Parameters

limitinteger
limit

The maximum number of items to list.

Type
integer
Format
"int32"
Minimum
0
Maximum
100
Default
100
markerstring
marker

The pagination token returned from the previous list operation.

Type
string
Responses

Responses​

A list of per-member personal access token summaries is returned.

application/json
JSON
{
  
"items": [
  
  
{
  
  
  
"memberId": "A1B2C3D4E5",
  
  
  
"activeTokenCount": 0,
  
  
  
"nearestExpiresAt": "string",
  
  
  
"latestLastUsedAt": "string"
  
  
}
  
],
  
"marker": "string"
}
DELETE/org/tokens/{tokenId}

Revoke a member's personal access token

Revokes a personal access token belonging to any member of the organization. The token immediately stops working. The token's owner can see that the token was revoked and by whom.

Responses

Responses​

The requested operation was done successfully.

Can't find the answer here? Email us: support@lakesail.com