Permissions

List all permissions for an API key

get

Path parameters

organizationIdstringRequired

The id of the organization to find teams within

apiKeyIdstringRequired

The id of the team

Query parameters

offsetinteger · int32Optional

The offset into queried items to return

limitinteger · int32 · max: 100Optional

How many items to return at one time (max 100)

Responses

200

A paged array of team permissions

application/json

default

An error occurred

application/json

get

HTTPcURLJavaScriptPython

GET /v1/identity/organizations/{organizationId}/api-keys/{apiKeyId}/permissions HTTP/1.1
Host: localhost:3050
Accept: */*

{
  "apiKeyPermissions": [
    {
      "id": "text",
      "projectId": "text",
      "createdAt": "text",
      "permission": {
        "resource": "text",
        "verb": "read"
      }
    }
  ],
  "totalResults": 1,
  "offset": 1,
  "limit": 1
}

Create an API Key permission

post

Path parameters

organizationIdstringRequired

The id of the organization to find teams within

apiKeyIdstringRequired

The id of the API key

Body

application/json

projectIdstringRequired

Responses

200

Expected response to a valid request

application/json

default

An error occurred

application/json

post

HTTPcURLJavaScriptPython

POST /v1/identity/organizations/{organizationId}/api-keys/{apiKeyId}/permissions HTTP/1.1
Host: localhost:3050
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "projectId": "text",
  "permission": {
    "resource": "text",
    "verb": "read"
  }
}

{
  "id": "text",
  "projectId": "text",
  "createdAt": "text",
  "permission": {
    "resource": "text",
    "verb": "read"
  }
}

Delete an API Key permission

delete

Path parameters

organizationIdstringRequired

The id of the organization to find teams within

apiKeyIdstringRequired

The id of the API key

permissionIdstringRequired

The id of the permission

Responses

204

Expected response to a valid request

No content

default

An error occurred

application/json

delete

HTTPcURLJavaScriptPython

DELETE /v1/identity/organizations/{organizationId}/api-keys/{apiKeyId}/permissions/{permissionId} HTTP/1.1
Host: localhost:3050
Accept: */*

No content