v4

latestOpenAPI 3.1.1Apache 2.02026-07-31107278570.4 KB
API Auth

List organization API clients

Retrieves a paginated list of API clients for a specific organization. Returns client details including metadata, scopes, and secret information (without exposing actual secret values).

get/api/v1/organizations/{organization_id}/clients

Path parameters

organization_idstring required

Unique identifier of the organization whose clients to list. Must start with 'org_' prefix.

Query parameters

page_sizeinteger

Maximum number of clients to return per page

Maximum number of API clients to return per page. Must be between 10 and 100

page_tokenstring

Pagination token from the previous response

Pagination token from the previous response. Use to retrieve the next page of organization clients

Response

List of organization API clients returned successfully. Each client includes its configuration details and metadata.

next_page_tokenstring

Pagination token for the next page of results. Use this token to fetch the next page.

prev_page_tokenstring

Pagination token for the previous page of results. Use this token to fetch the previous page.

total_sizeinteger

Total number of API clients in the organization.

Example response

{
  "clients": [
    {
      "audience": [
        "https://api.example.com"
      ],
      "client_id": "m2morg_1231234233424344",
      "create_time": "2024-01-05T14:48:00Z",
      "custom_claims": [
        {
          "key": "environment",
          "value": "production"
        }
      ],
      "description": "Service account for automated deployment processes",
      "metadata_uri": "https://example.com/client-metadata.json",
      "name": "GitHub Actions Deployment Service",
      "organization_id": "org_1231234233424344",
      "redirect_uris": [
        "https://example.com/callback"
      ],
      "resource_id": "app_1231234233424344",
      "scopes": [
        "deploy:resources",
        "read:deployments"
      ],
      "secrets": [
        {
          "create_time": "2024-01-05T14:48:00Z",
          "created_by": "user_12345",
          "expire_time": "2025-01-05T14:48:00Z",
          "id": "sec_1234abcd5678efgh",
          "last_used_time": "2024-02-15T10:30:00Z",
          "plain_secret": "sec_1234567890abcdefghijklmnopqrstuvwxyz",
          "secret_suffix": "xyzw",
          "update_time": "2024-01-10T09:12:00Z"
        }
      ],
      "update_time": "2024-01-05T14:48:00Z"
    }
  ],
  "next_page_token": "<next_page_token>",
  "prev_page_token": "<prev_page_token>",
  "total_size": 30
}