Api keys

List all API keys within an organization

get

Path parameters

organizationIdstringRequired

The id of the organization to find API keys within

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 API keys

application/json

totalResultsintegerRequired

offsetintegerRequired

limitintegerRequired

default

An error occurred

application/json

get/v1/identity/organizations/{organizationId}/api-keys

HTTPcURLJavaScriptPython

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

{
  "apiKeys": [
    {
      "id": "text",
      "name": "text",
      "createdAt": "text",
      "createdBy": {
        "userId": "text",
        "type": "user"
      }
    }
  ],
  "totalResults": 1,
  "offset": 1,
  "limit": 1
}

Create an API key

post

Path parameters

organizationIdstringRequired

The id of the organization to find API keys within

Body

application/json

namestringRequired

Responses

200

Expected response to a valid request

application/json

apiKeyTokenstringRequired

default

An error occurred

application/json

post/v1/identity/organizations/{organizationId}/api-keys

HTTPcURLJavaScriptPython

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

{
  "name": "text"
}

{
  "apiKey": {
    "id": "text",
    "name": "text",
    "createdAt": "text",
    "createdBy": {
      "userId": "text",
      "type": "user"
    }
  },
  "apiKeyToken": "text"
}

Get an API key

get

Path parameters

organizationIdstringRequired

The id of the organization the API key is within

apiKeyIdstringRequired

The id of the API key

Responses

200

An API key

application/json

idstringRequired

namestringRequired

createdAtstringRequired

createdByone ofOptional

or

default

An error occurred

application/json

get/v1/identity/organizations/{organizationId}/api-keys/{apiKeyId}

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "name": "text",
  "createdAt": "text",
  "createdBy": {
    "userId": "text",
    "type": "user"
  }
}

Update an API Key

post

Path parameters

organizationIdstringRequired

The id of the organization the API key is within

apiKeyIdstringRequired

The id of the API key

Body

application/json

namestringRequired

Responses

200

Expected response to a valid request

application/json

idstringRequired

namestringRequired

createdAtstringRequired

createdByone ofOptional

or

default

An error occurred

application/json

post/v1/identity/organizations/{organizationId}/api-keys/{apiKeyId}

HTTPcURLJavaScriptPython

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

{
  "name": "text"
}

{
  "id": "text",
  "name": "text",
  "createdAt": "text",
  "createdBy": {
    "userId": "text",
    "type": "user"
  }
}

Delete an API Key

delete

Path parameters

organizationIdstringRequired

The id of the organization the API key is within

apiKeyIdstringRequired

The id of the API key

Responses

204

Expected response to a valid request

No content

default

An error occurred

application/json

delete/v1/identity/organizations/{organizationId}/api-keys/{apiKeyId}

HTTPcURLJavaScriptPython

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

No content