Sign in
apiCredentials

List API Credentials for an Organization

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

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

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

Changed in 6 of the 41 revisions of this API.213

  • 6129323514c11See the full diff
    • ●

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

      response-property-enum-value-added

  • 53d0b0012c3a1See the full diff
    • ○

      added the required property // to the response with the status

      response-required-property-added

  • bfa460b2aec31See the full diff
    • ○

      the // response's property pattern ^[A-Za-z0-9-]+$ was added for the status

      response-property-pattern-added

  • 9bda0eaca3451See the full diff
    • ▲

      removed the required property // from the response with the status

      response-required-property-removed

  • f2d7d1ad34951See the full diff
    • ▲

      removed the required property // from the response with the 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

  • ff88074443981See the full diff
    • ○

      endpoint added

      endpoint-added