CRcriblio
apiCredentials

List API Credentials for an Organization

Changed on

Get a list of all API Credentials for the specified Organization.

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

Request

  • Base URL
    https://gateway.cribl.cloud
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://login.cribl.cloud/oauth/token
    • or HTTP bearer

Path parameters

organizationIdstring required

The <code>id</code> of the Organization whose API Credentials you want to list.

Response

API Credentials retrieved

countinteger required

Total number of API Credentials listed in the response.

Example response

{
  "items": [
    {
      "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"
    }
  ],
  "count": 1
}

Changes

  • 530e0f792d9fRevision changes
    • warning

      added the new billing_reader enum value to the /////////// response property for the response status

  • 6129323514c1Revision changes
    • warning

      added the new insights enum value to the /////////////// response property for the response status