Access keys
Last updated
Was this helpful?
Last updated
Was this helpful?
Retrieve a single access key.
The organization ID
ID for an access key
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-06-20T17:24:22.944Z",
"createdAt": "2025-06-20T17:24:22.944Z",
"updatedAt": "2025-06-20T17:24:22.944Z",
"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-06-20T17:24:22.944Z",
"updatedAt": "2025-06-20T17:24:22.944Z",
"metadata": {
"clouds": [
"platform"
],
"apps": [
"inbox"
],
"groups": [
"text"
]
}
}
],
"usersDependencyCount": 1,
"accessKeysDependencyCount": 1,
"createdAt": "2025-06-20T17:24:22.944Z",
"updatedAt": "2025-06-20T17:24:22.944Z",
"metadata": {
"clouds": [
"platform"
]
},
"actions": [
{
"name": "text",
"type": "text"
}
]
}
]
}Remove the access key from the organization.
The organization ID
ID for an access key
DELETE /organizations/{organizationId}/access-keys/{accessKeyId} HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
No content
List the access keys that are created for this organization.
The organization ID
Limits the number of results to return
10Pagination token that keeps of track of the current position in the list
Order in which to retrieve the results
falseGET /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-06-20T17:24:22.944Z",
"createdAt": "2025-06-20T17:24:22.944Z",
"updatedAt": "2025-06-20T17:24:22.944Z",
"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.
The organization ID
Access key name.
Access key description.
IAM roles attached to this access key.
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-06-20T17:24:22.944Z",
"createdAt": "2025-06-20T17:24:22.944Z",
"updatedAt": "2025-06-20T17:24:22.944Z",
"roleRefs": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "organization",
"workspaces": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
]
},
"token": "text"
}Update the access key's properties.
The organization ID
ID for an access key
Access key name.
Access key description.
IAM roles attached to this access key.
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-06-20T17:24:22.944Z",
"createdAt": "2025-06-20T17:24:22.944Z",
"updatedAt": "2025-06-20T17:24:22.944Z",
"roleRefs": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "organization",
"workspaces": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
]
}