Access Keys

Access Keys

List access keys for an organization

get

Retrieve the list of access keys that belong to an organization

Authorizations

apiAuth

Path parameters

organizationIdstring · uuidRequired

Organization ID

Responses

200

OK

No content

get

/organizations/{organizationId}/access-keys

HTTPcURLJavaScriptPython

GET /organizations/{organizationId}/access-keys HTTP/1.1
Host: 
Accept: */*

200

OK

No content

Create a new access key

post

Create a new access key for the organization

Authorizations

apiAuth

Path parameters

organizationIdstring · uuidRequired

Organization ID

Body

application/json

namestringRequiredExample: Access Key Name

descriptionstringRequiredExample: Access Key Description

roleRefsstring · uuid[]Optional

Responses

201

Created

post

/organizations/{organizationId}/access-keys

HTTPcURLJavaScriptPython

POST /organizations/{organizationId}/access-keys HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 117

{
  "name": "Access Key Name",
  "description": "Access Key Description",
  "roleRefs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

201

Created

No content

Update an access key

post

Update an existing access key

Authorizations

apiAuth

Path parameters

idstring · uuidRequired

Access Key ID

Body

application/json

namestringRequiredExample: Updated Access Key Name

descriptionstringRequiredExample: Updated Access Key Description

roleRefsstring · uuid[]Optional

Responses

200

Updated

No content

post

/api/organizations/{organizationId}/access-keys/{id}

HTTPcURLJavaScriptPython

POST /api/organizations/{organizationId}/access-keys/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 133

{
  "name": "Updated Access Key Name",
  "description": "Updated Access Key Description",
  "roleRefs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

200

Updated

No content

Delete an access key

delete

Delete an existing access key

Authorizations

apiAuth

Path parameters

idstring · uuidRequired

Access Key ID

Responses

200

Deleted

No content

delete

/api/organizations/{organizationId}/access-keys/{id}

HTTPcURLJavaScriptPython

DELETE /api/organizations/{organizationId}/access-keys/{id} HTTP/1.1
Host: 
Accept: */*

200

Deleted

No content