Current User
Current principal, sessions, tokens, and privileges.
Operations
Each operation lists its specific responses. See Common error responses for errors shared by every operation on this page.
Get current principal
GET /api/v1/me
Operation ID: getCurrentPrincipal
Effect: read
Confirmation: never
Required privilege: USE_WORKSPACE
Focused reference: JSON · Markdown
Responses
| Status | Description |
|---|---|
200 |
The request has succeeded. |
List current API tokens
GET /api/v1/me/api-tokens
Operation ID: listCurrentAPITokens
Effect: read
Confirmation: never
Required privilege: MANAGE_GRANTS
Focused reference: JSON · Markdown
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
limit |
query | No | integer | |
pageToken |
query | No | string |
Responses
| Status | Description |
|---|---|
200 |
The request has succeeded. |
Create current API token
POST /api/v1/me/api-tokens
Operation ID: createCurrentAPIToken
Effect: write
Confirmation: conditional
Required privilege: MANAGE_GRANTS
Focused reference: JSON · Markdown
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
Idempotency-Key |
header | Yes | string |
Request body
Content types: application/json.
Responses
| Status | Description |
|---|---|
201 |
The request has succeeded and a new resource has been created as a result. |
Revoke current API token
DELETE /api/v1/me/api-tokens/{token}
Operation ID: revokeCurrentAPIToken
Effect: destructive
Confirmation: required
Required privilege: MANAGE_GRANTS
Focused reference: JSON · Markdown
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
token |
path | Yes | string |
Responses
| Status | Description |
|---|---|
204 |
There is no content to send for this request, but the headers may be useful. |
List current effective privileges
GET /api/v1/me/effective-privileges
Operation ID: listCurrentEffectivePrivileges
Effect: read
Confirmation: never
Required privilege: USE_WORKSPACE
Focused reference: JSON · Markdown
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workspace |
query | No | string |
Responses
| Status | Description |
|---|---|
200 |
The request has succeeded. |
List current sessions
GET /api/v1/me/sessions
Operation ID: listCurrentSessions
Effect: read
Confirmation: never
Required privilege: USE_WORKSPACE
Focused reference: JSON · Markdown
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
limit |
query | No | integer | |
pageToken |
query | No | string |
Responses
| Status | Description |
|---|---|
200 |
The request has succeeded. |
Revoke current session
DELETE /api/v1/me/sessions/{session}
Operation ID: revokeCurrentSession
Effect: destructive
Confirmation: required
Required privilege: USE_WORKSPACE
Focused reference: JSON · Markdown
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
session |
path | Yes | string |
Responses
| Status | Description |
|---|---|
204 |
There is no content to send for this request, but the headers may be useful. |
Common error responses
These error responses apply to every operation on this page.
| Status | Description |
|---|---|
400 |
The server could not understand the request due to invalid syntax. |
401 |
Access is unauthorized. |
403 |
Access is forbidden. |
404 |
The server cannot find the requested resource. |
409 |
The request conflicts with the current state of the server. |
412 |
Precondition failed. |
413 |
Client error |
415 |
Client error |
422 |
Client error |
429 |
Client error |
500 |
Server error |
502 |
Server error |
503 |
Service unavailable. |