Sign in

v34

OpenAPI 3.1.0raw.githubusercontent.com2026-07-130042.4 KB
apiCredentials

Get an API Credential

Get the specified API Credential.

get/v1/organizations/{organizationId}/api-credentials/{apiCredentialId}

Path parameters

organizationIdstring required

The <code>id</code> of the Organization whose API Credential you want to retrieve.

apiCredentialIdstring required

The <code>clientId</code> of the API Credential to retrieve.

Response

API Credential retrieved

namestring required

Human-readable name of the API Credential.

descriptionstring required

Brief description of the purpose and usage for the API Credential.

enabledboolean required

If <code>true</code>, the API Credential is enabled. Otherwise, <code>false</code>.

organizationIdstring required

Unique ID of the Organization.

clientIdstring required

Client ID for the API Credential.

ipAllowliststring[] required

CIDR range enforced as the IP allowlist for the API Credential. An empty array means that the API Credential has no IP restrictions.

createdBystring required

Member who created the API Credential.

createdDatestring date-time required

ISO 8601 timestamp when the API Credential was created.

lastUpdatedBystring required

Member who last updated the API Credential.

lastUpdatedDatestring date-time required

ISO 8601 timestamp when the API Credential was last updated.

Example response

{
  "name": "Auto-Manage-Workspaces",
  "description": "Used for automated Workspace management",
  "enabled": true,
  "organizationId": "org-123",
  "clientId": "clientIdabcd1234EXAMPLE",
  "roles": {
    "workspaces": [
      {
        "workspaceId": "main"
      }
    ]
  },
  "ipAllowlist": [
    "10.0.0.1/32"
  ],
  "createdBy": "user@example.com",
  "createdDate": "2024-08-15T12:34:56.000Z",
  "lastUpdatedBy": "user@example.com",
  "lastUpdatedDate": "2024-08-15T12:34:56.000Z"
}