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"
}

Changes

Changed in 7 of the 41 revisions of this API.214

Aug 12, 20266129323514c11See the full diff
- ●
  added the new insights enum value to the roles/allOf[ApiCredentialRolesSchema]/workspaces/items/products/items/product/allOf[ProductName]/ response property for the response status 200
  response-property-enum-value-added
Apr 22, 202653d0b0012c3a1See the full diff
- ○
  added the required property ipAllowlist to the response with the 200 status
  response-required-property-added
Mar 18, 2026aecdd0a7e96c1See the full diff
- ○
  added the non-success response with the status 404
  response-non-success-status-added
Mar 12, 2026da33e1b4a4331See the full diff
- ▲
  removed the required property clientSecret from the response with the 200 status
  response-required-property-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 4, 2026bfa460b2aec31See the full diff
- ○
  the name response's property pattern ^[A-Za-z0-9-]+$ was added for the status 200
  response-property-pattern-added
Mar 4, 20269bda0eaca3451See the full diff
- ▲
  removed the required property workspaceId from the response with the 200 status
  response-required-property-removed
Feb 2, 2026f2d7d1ad34951See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history