List creatable API key scopes

GET

/api/v1/api-keys/creatable-scopes

const url = 'https://localhost:8080/api/v1/api-keys/creatable-scopes';
const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://localhost:8080/api/v1/api-keys/creatable-scopes \
  --header 'Authorization: <Authorization>'

Return the ordered catalog of create-time API key scopes and whether the caller may grant each one. Optional organization_id and project_id overlay the same bindings as create. JWT/session only — API keys cannot manage API keys

Authorizations

BearerAuth

Parameters

Query Parameters

organization_id

string

Override organization used for grant checks

project_id

string

Override project used for grant checks

Responses

200

Creatable scopes for the caller

application/json

Creatable API key scopes for the authenticated caller, including non-grantable rows

object

scopes

Array<object>

A create-time API key scope, whether the caller may grant it, and copy for the picker

object

category

string

description

string

grantable

boolean

ignoresProjectBinding

boolean

kind

string

Allowed values: full_access service rbac

label

string

name

string

Example

{
  "scopes": [
    {
      "kind": "full_access"
    }
  ]
}

400

Bad request - Invalid organization or project ID

application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

401

Unauthorized - Authentication required

application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

403

Forbidden - API keys cannot manage API keys

application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}