Access keys
List the access keys that are created for this organization.
Authorizations
Path parameters
organizationIdstringRequired
The organization ID
Query parameters
limitinteger · min: 1 · max: 100OptionalDefault:
Limits the number of results to return
10
pageTokenstringOptional
Pagination token that keeps of track of the current position in the list
reversebooleanOptionalDefault:
Order in which to retrieve the results
false
Responses
200
OK
application/json
Responseall of
and
404
Resource not found
application/json
get
GET /organizations/{organizationId}/access-keys HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
{
"results": [
{
"id": "text",
"organizationId": "text",
"name": "text",
"type": "user",
"description": "text",
"suffix": "text",
"lastUsedAt": "2025-07-05T17:35:38.976Z",
"createdAt": "2025-07-05T17:35:38.976Z",
"updatedAt": "2025-07-05T17:35:38.976Z",
"roleRefs": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "organization",
"workspaces": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
]
}
],
"nextPageToken": "text"
}
Create a new access key for the organization.
Authorizations
Path parameters
organizationIdstringRequired
The organization ID
Body
namestring · min: 1 · max: 256Required
Access key name.
descriptionstring · min: 1 · max: 256Required
Access key description.
roleIdsstring · uuid[] · min: 1 · max: 5OptionalDeprecated
IAM roles attached to this access key.
Responses
201
Created
application/json
404
Resource not found
application/json
422
Request validation failed
application/json
post
POST /organizations/{organizationId}/access-keys HTTP/1.1
Host:
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 171
{
"name": "text",
"description": "text",
"roleRefs": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "organization",
"workspaces": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
]
}
{
"accessKey": {
"id": "text",
"organizationId": "text",
"name": "text",
"type": "user",
"description": "text",
"suffix": "text",
"lastUsedAt": "2025-07-05T17:35:38.976Z",
"createdAt": "2025-07-05T17:35:38.976Z",
"updatedAt": "2025-07-05T17:35:38.976Z",
"roleRefs": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "organization",
"workspaces": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
]
},
"token": "text"
}
Retrieve a single access key.
Authorizations
Path parameters
organizationIdstringRequired
The organization ID
accessKeyIdstringRequired
ID for an access key
Responses
200
OK
application/json
404
Resource not found
application/json
get
GET /organizations/{organizationId}/access-keys/{accessKeyId} HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"organizationId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"type": "user",
"description": "text",
"suffix": "text",
"lastUsedAt": "2025-07-05T17:35:38.976Z",
"createdAt": "2025-07-05T17:35:38.976Z",
"updatedAt": "2025-07-05T17:35:38.976Z",
"roles": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"organizationId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"type": "organization",
"policies": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"definitions": [
{
"effect": "allow",
"resources": [
"text"
],
"actions": [
"any"
],
"conditionsAll": [
{
"any": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
}
]
}
],
"rolesDependencyCount": 1,
"usersDependencyCount": 1,
"scope": "organization",
"type": "managed",
"createdAt": "2025-07-05T17:35:38.976Z",
"updatedAt": "2025-07-05T17:35:38.976Z",
"metadata": {
"clouds": [
"platform"
],
"apps": [
"inbox"
],
"groups": [
"text"
]
}
}
],
"usersDependencyCount": 1,
"accessKeysDependencyCount": 1,
"createdAt": "2025-07-05T17:35:38.976Z",
"updatedAt": "2025-07-05T17:35:38.976Z",
"metadata": {
"clouds": [
"platform"
]
},
"actions": [
{
"name": "text",
"type": "text"
}
]
}
]
}
Remove the access key from the organization.
Authorizations
Path parameters
organizationIdstringRequired
The organization ID
accessKeyIdstringRequired
ID for an access key
Responses
204
OK
404
Resource not found
application/json
delete
DELETE /organizations/{organizationId}/access-keys/{accessKeyId} HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
No content
Update the access key's properties.
Authorizations
Path parameters
organizationIdstringRequired
The organization ID
accessKeyIdstringRequired
ID for an access key
Body
namestring · min: 1 · max: 256Optional
Access key name.
descriptionstring · min: 1 · max: 256Optional
Access key description.
roleIdsstring · uuid[] · min: 1 · max: 5OptionalDeprecated
IAM roles attached to this access key.
Responses
200
OK
application/json
404
Resource not found
application/json
409
Server had a temporary failure
application/json
422
Request validation failed
application/json
patch
PATCH /organizations/{organizationId}/access-keys/{accessKeyId} HTTP/1.1
Host:
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 171
{
"name": "text",
"description": "text",
"roleRefs": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "organization",
"workspaces": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
]
}
{
"id": "text",
"organizationId": "text",
"name": "text",
"type": "user",
"description": "text",
"suffix": "text",
"lastUsedAt": "2025-07-05T17:35:38.976Z",
"createdAt": "2025-07-05T17:35:38.976Z",
"updatedAt": "2025-07-05T17:35:38.976Z",
"roleRefs": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "organization",
"workspaces": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
]
}
Last updated
Was this helpful?