Anthropic Organizations API

openapi: 3.2.0
info:
  title: Anthropic Organizations API
servers:
- url: https://api.anthropic.com
tags:
- name: Organizations
paths:
  /v1/organizations/api_keys/{api_key_id}?beta=true:
    get:
      summary: Get API Key
      operationId: beta_get_api_key_v1_organizations_api_keys__api_key_id__get
      parameters:
      - name: api_key_id
        in: path
        required: true
        schema:
          type: string
          description: ID of the API key.
          title: Api Key Id
        description: ID of the API key.
      - name: x-api-key
        in: header
        required: false
        schema:
          type: string
          description: "Your unique Admin API key for authentication. \n\nThis key is required in the header of all Admin API requests, to authenticate your account and access Anthropic's services. Get your Admin API key through the [Console](https://console.anthropic.com/settings/admin-keys)."
          title: X-Api-Key
        description: "Your unique Admin API key for authentication. \n\nThis key is required in the header of all Admin API requests, to authenticate your account and access Anthropic's services. Get your Admin API key through the [Console](https://console.anthropic.com/settings/admin-keys)."
      - name: anthropic-version
        in: header
        required: false
        schema:
          type: string
          description: 'The version of the Claude API you want to use.


            Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).'
          title: Anthropic-Version
        description: 'The version of the Claude API you want to use.


          Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BetaApiKey'
        4XX:
          description: 'Error response.


            See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BetaErrorResponse'
      tags:
      - Organizations
    post:
      summary: Update API Key
      operationId: beta_update_api_key_v1_organizations_api_keys__api_key_id__post
      parameters:
      - name: api_key_id
        in: path
        required: true
        schema:
          type: string
          description: ID of the API key.
          title: Api Key Id
        description: ID of the API key.
      - name: anthropic-version
        in: header
        required: false
        schema:
          type: string
          description: 'The version of the Claude API you want to use.


            Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).'
          title: Anthropic-Version
        description: 'The version of the Claude API you want to use.


          Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BetaApiKeyUpdateParams'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BetaApiKey'
        4XX:
          description: 'Error response.


            See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BetaErrorResponse'
      tags:
      - Organizations
  /v1/organizations/api_keys?beta=true:
    get:
      summary: List API Keys
      operationId: beta_list_api_keys_v1_organizations_api_keys_get
      parameters:
      - name: before_id
        in: query
        required: false
        schema:
          type: string
          description: ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.
          title: Before Id
        description: ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.
      - name: after_id
        in: query
        required: false
        schema:
          type: string
          description: ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.
          title: After Id
        description: ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 1000
          minimum: 1
          description: 'Number of items to return per page.


            Defaults to `20`. Ranges from `1` to `1000`.'
          default: 20
          title: Limit
        description: 'Number of items to return per page.


          Defaults to `20`. Ranges from `1` to `1000`.'
      - name: status
        in: query
        required: false
        schema:
          anyOf:
          - enum:
            - active
            - archived
            - expired
            - inactive
            type: string
          - type: 'null'
          description: Filter by API key status.
          title: Status
        description: Filter by API key status.
      - name: workspace_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by Workspace ID.
          title: Workspace Id
        description: Filter by Workspace ID.
      - name: created_by_user_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by the ID of the User who created the object.
          title: Created By User Id
        description: Filter by the ID of the User who created the object.
      - name: x-api-key
        in: header
        required: false
        schema:
          type: string
          description: "Your unique Admin API key for authentication. \n\nThis key is required in the header of all Admin API requests, to authenticate your account and access Anthropic's services. Get your Admin API key through the [Console](https://console.anthropic.com/settings/admin-keys)."
          title: X-Api-Key
        description: "Your unique Admin API key for authentication. \n\nThis key is required in the header of all Admin API requests, to authenticate your account and access Anthropic's services. Get your Admin API key through the [Console](https://console.anthropic.com/settings/admin-keys)."
      - name: anthropic-version
        in: header
        required: false
        schema:
          type: string
          description: 'The version of the Claude API you want to use.


            Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).'
          title: Anthropic-Version
        description: 'The version of the Claude API you want to use.


          Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BetaListResponse_ApiKey_'
        4XX:
          description: 'Error response.


            See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BetaErrorResponse'
      tags:
      - Organizations
  /v1/organizations/cost_report?beta=true:
    get:
      summary: Get Cost Report
      operationId: beta_get_cost_report_v1_organizations_cost_report_get
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 31
          minimum: 1
          description: Maximum number of time buckets to return in the response.
          examples:
          - 7
          default: 7
          title: Limit
        description: Maximum number of time buckets to return in the response.
      - name: page
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Optionally set to the `next_page` token from the previous response.
          examples:
          - page_MjAyNS0wNS0xNFQwMDowMDowMFo=
          - null
          title: Page
        description: Optionally set to the `next_page` token from the previous response.
      - name: starting_at
        in: query
        required: true
        schema:
          type: string
          format: date-time
          description: 'Time buckets that start on or after this RFC 3339 timestamp will be returned.

            Each time bucket will be snapped to the start of the minute/hour/day in UTC.'
          examples:
          - '2024-10-30T23:58:27.427722Z'
          title: Starting At
        description: 'Time buckets that start on or after this RFC 3339 timestamp will be returned.

          Each time bucket will be snapped to the start of the minute/hour/day in UTC.'
      - name: ending_at
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          description: Time buckets that end before this RFC 3339 timestamp will be returned.
          examples:
          - '2024-10-30T23:58:27.427722Z'
          title: Ending At
        description: Time buckets that end before this RFC 3339 timestamp will be returned.
      - name: group_by[]
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              $ref: '#/components/schemas/BetaCostReportGroupBy'
          - type: 'null'
          description: Group by any subset of the available options.
          examples:
          - workspace_id
          - description
          title: Group By[]
        description: Group by any subset of the available options.
      - name: bucket_width
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/BetaCostReportTimeBucketWidth'
          description: Time granularity of the response data.
          examples:
          - 1d
          default: 1d
        description: Time granularity of the response data.
      - name: anthropic-beta
        in: header
        required: false
        schema:
          type: string
          items:
            type: string
          description: 'Optional header to specify the beta version(s) you want to use.


            To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.'
          title: Anthropic-Beta
          x-stainless-override-schema:
            x-stainless-param: betas
            x-stainless-extend-default: true
            type: array
            description: Optional header to specify the beta version(s) you want to use.
            items:
              $ref: '#/components/schemas/AnthropicBeta'
        description: 'Optional header to specify the beta version(s) you want to use.


          To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.'
      - name: x-api-key
        in: header
        required: false
        schema:
          type: string
          description: "Your unique Admin API key for authentication. \n\nThis key is required in the header of all Admin API requests, to authenticate your account and access Anthropic's services. Get your Admin API key through the [Console](https://console.anthropic.com/settings/admin-keys)."
          title: X-Api-Key
        description: "Your unique Admin API key for authentication. \n\nThis key is required in the header of all Admin API requests, to authenticate your account and access Anthropic's services. Get your Admin API key through the [Console](https://console.anthropic.com/settings/admin-keys)."
      - name: anthropic-version
        in: header
        required: false
        schema:
          type: string
          description: 'The version of the Claude API you want to use.


            Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).'
          title: Anthropic-Version
        description: 'The version of the Claude API you want to use.


          Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BetaGetCostReportResponse'
        4XX:
          description: 'Error response.


            See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BetaErrorResponse'
      tags:
      - Organizations
  /v1/organizations/external_keys/{external_key_id}/validate?beta=true:
    post:
      summary: Validate External Key
      description: 'Validate an external key config against the customer''s KMS.


        Anthropic performs an encrypt/decrypt roundtrip against the configured

        KMS key and waits up to 30 seconds for the result. The response status is

        `success` if the roundtrip succeeded, or `failure` with an error

        message if it failed or timed out.'
      operationId: beta_validate_external_key_v1_organizations_external_keys__external_key_id__validate_post
      parameters:
      - name: external_key_id
        in: path
        required: true
        schema:
          type: string
          maxLength: 2048
          description: ID of the External Key.
          title: External Key Id
        description: ID of the External Key.
      - name: anthropic-version
        in: header
        required: false
        schema:
          type: string
          description: 'The version of the Claude API you want to use.


            Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).'
          title: Anthropic-Version
        description: 'The version of the Claude API you want to use.


          Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BetaValidateExternalKeyResponse'
        4XX:
          description: 'Error response.


            See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BetaErrorResponse'
      tags:
      - Organizations
  /v1/organizations/external_keys/{external_key_id}?beta=true:
    get:
      summary: Get External Key
      description: Retrieve a single external key config in the caller's organization by ID.
      operationId: beta_get_external_key_v1_organizations_external_keys__external_key_id__get
      parameters:
      - name: external_key_id
        in: path
        required: true
        schema:
          type: string
          maxLength: 2048
          description: ID of the External Key.
          title: External Key Id
        description: ID of the External Key.
      - name: x-api-key
        in: header
        required: false
        schema:
          type: string
          description: "Your unique Admin API key for authentication. \n\nThis key is required in the header of all Admin API requests, to authenticate your account and access Anthropic's services. Get your Admin API key through the [Console](https://console.anthropic.com/settings/admin-keys)."
          title: X-Api-Key
        description: "Your unique Admin API key for authentication. \n\nThis key is required in the header of all Admin API requests, to authenticate your account and access Anthropic's services. Get your Admin API key through the [Console](https://console.anthropic.com/settings/admin-keys)."
      - name: anthropic-version
        in: header
        required: false
        schema:
          type: string
          description: 'The version of the Claude API you want to use.


            Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).'
          title: Anthropic-Version
        description: 'The version of the Claude API you want to use.


          Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BetaExternalKey'
        4XX:
          description: 'Error response.


            See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BetaErrorResponse'
      tags:
      - Organizations
    post:
      summary: Update External Key
      description: 'Partially update an external key config. Omitted fields are left unchanged.


        `display_name` is always editable. `geo` and `provider_config` cannot

        be changed once any workspace references this config, because previously

        encrypted data requires the original key identity to decrypt.'
      operationId: beta_update_external_key_v1_organizations_external_keys__external_key_id__post
      parameters:
      - name: external_key_id
        in: path
        required: true
        schema:
          type: string
          maxLength: 2048
          description: ID of the External Key.
          title: External Key Id
        description: ID of the External Key.
      - name: anthropic-version
        in: header
        required: false
        schema:
          type: string
          description: 'The version of the Claude API you want to use.


            Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).'
          title: Anthropic-Version
        description: 'The version of the Claude API you want to use.


          Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BetaExternalKeyUpdateParams'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BetaExternalKey'
        4XX:
          description: 'Error response.


            See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BetaErrorResponse'
      tags:
      - Organizations
    delete:
      summary: Delete External Key
      description: 'Delete an external key config.


        The request is rejected if any workspace still references this config.'
      operationId: beta_delete_external_key_v1_organizations_external_keys__external_key_id__delete
      parameters:
      - name: external_key_id
        in: path
        required: true
        schema:
          type: string
          maxLength: 2048
          description: ID of the External Key.
          title: External Key Id
        description: ID of the External Key.
      - name: x-api-key
        in: header
        required: false
        schema:
          type: string
          description: "Your unique Admin API key for authentication. \n\nThis key is required in the header of all Admin API requests, to authenticate your account and access Anthropic's services. Get your Admin API key through the [Console](https://console.anthropic.com/settings/admin-keys)."
          title: X-Api-Key
        description: "Your unique Admin API key for authentication. \n\nThis key is required in the header of all Admin API requests, to authenticate your account and access Anthropic's services. Get your Admin API key through the [Console](https://console.anthropic.com/settings/admin-keys)."
      - name: anthropic-version
        in: header
        required: false
        schema:
          type: string
          description: 'The version of the Claude API you want to use.


            Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).'
          title: Anthropic-Version
        description: 'The version of the Claude API you want to use.


          Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BetaDeleteExternalKeyResponse'
        4XX:
          description: 'Error response.


            See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BetaErrorResponse'
      tags:
      - Organizations
  /v1/organizations/external_keys?beta=true:
    post:
      summary: Create External Key
      description: Create an external key config owned by the caller's organization.
      operationId: beta_create_external_key_v1_organizations_external_keys_post
      parameters:
      - name: anthropic-version
        in: header
        required: false
        schema:
          type: string
          description: 'The version of the Claude API you want to use.


            Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).'
          title: Anthropic-Version
        description: 'The version of the Claude API you want to use.


          Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BetaExternalKeyCreateParams'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BetaExternalKey'
        4XX:
          description: 'Error response.


            See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BetaErrorResponse'
      tags:
      - Organizations
    get:
      summary: List External Keys
      description: 'List external key configs in the caller''s organization.


        Results are ordered by creation time (newest first). Use the

        `next_page` cursor from the response to fetch subsequent pages.'
      operationId: beta_list_external_keys_v1_organizations_external_keys_get
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          description: Number of results per page.
          default: 20
          title: Limit
        description: Number of results per page.
      - name: page
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Opaque cursor from a previous response's `next_page`.
          title: Page
        description: Opaque cursor from a previous response's `next_page`.
      - name: x-api-key
        in: header
        required: false
        schema:
          type: string
          description: "Your unique Admin API key for authentication. \n\nThis key is required in the header of all Admin API requests, to authenticate your account and access Anthropic's services. Get your Admin API key through the [Console](https://console.anthropic.com/settings/admin-keys)."
          title: X-Api-Key
        description: "Your unique Admin API key for authentication. \n\nThis key is required in the header of all Admin API requests, to authenticate your account and access Anthropic's services. Get your Admin API key through the [Console](https://console.anthropic.com/settings/admin-keys)."
      - name: anthropic-version
        in: header
        required: false
        schema:
          type: string
          description: 'The version of the Claude API you want to use.


            Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).'
          title: Anthropic-Version
        description: 'The version of the Claude API you want to use.


          Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BetaExternalKeyListResponse'
        4XX:
          description: 'Error response.


            See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BetaErrorResponse'
      tags:
      - Organizations
  /v1/organizations/federation_issuers/{federation_issuer_id}/archive?beta=true:
    post:
      summary: Archive Federation Issuer
      description: '**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).


        Archive a federation issuer.


        Idempotent; re-archiving returns the issuer with its original

        `archived_at`. Rejected with 400 if any live (non-archived) federation

        rule still references the issuer; archive those rules first (a rule''s

        issuer cannot be changed), or recreate them against another issuer.'
      operationId: beta_archive_federation_issuer_v1_organizations_federation_issuers__federation_issuer_id__archive_post
      parameters:
      - name: federation_issuer_id
        in: path
        required: true
        schema:
          type: string
          description: ID of the federation issuer to archive.
          title: Federation Issuer Id
        description: ID of the federation issuer to archive.
      - name: anthropic-beta
        in: header
        required: false
        schema:
          type: string
          items:
            type: string
          description: 'Optional header to specify the beta version(s) you want to use.


            To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.'
          title: Anthropic-Beta
          x-stainless-override-schema:
            x-stainless-param: betas
            x-stainless-extend-default: true
            type: array
            description: Optional header to specify the beta version(s) you want to use.
            items:
              $ref: '#/components/schemas/AnthropicBeta'
        description: 'Optional header to specify the beta version(s) you want to use.


          To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.'
      - name: anthropic-version
        in: header
        required: false
        schema:
          type: string
          description: 'The version of the Claude API you want to use.


            Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).'
          title: Anthropic-Version
        description: 'The version of the Claude API you want to use.


          Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BetaFederationIssuer'
        4XX:
          description: 'Error response.


            See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BetaErrorResponse'
      tags:
      - Organizations
  /v1/organizations/federation_issuers/{federation_issuer_id}?beta=true:
    get:
      summary: Get Federation Issuer
      description: '**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).


        Retrieve a federation issuer by its ID (`fdis_...`).'
      operationId: beta_get_federation_issuer_v1_organizations_federation_issuers__federation_issuer_id__get
      parameters:
      - name: federation_issuer_id
        in: path
        required: true
        schema:
          type: string
          description: ID of the federation issuer.
          title: Federation Issuer Id
        description: ID of the federation issuer.
      - name: anthropic-beta
        in: header
        required: false
        schema:
          type: string
          items:
            type: string
          description: 'Optional header to specify the beta version(s) you want to use.


            To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.'
          title: Anthropic-Beta
          x-stainless-override-schema:
            x-stainless-param: betas
            x-stainless-extend-default: true
            type: array
            description: Optional header to specify the beta version(s) you want to use.
            items:
              $ref: '#/components/schemas/AnthropicBeta'
        description: 'Optional header to specify the beta version(s) you want to use.


          To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.'
      - name: x-api-key
        in: header
        required: false
        schema:
          type: string
          description: "Your unique Admin API key for authentication. \n\nThis key is required in the header of all Admin API requests, to authenticate your account and access Anthropic's services. Get your Admin API key through the [Console](https://console.anthropic.com/settings/admin-keys)."
          title: X-Api-Key
        description: "Your unique Admin API key for authentication. \n\nThis key is required in the header of all Admin API requests, to authenticate your account and access Anthropic's services. Get your Admin API key through the [Console](https://console.anthropic.com/settings/admin-keys)."
      - name: anthropic-version
        in: header
        required: false
        schema:
          type: string
          description: 'The version of the Claude API you want to use.


            Read more about versioning and our version history [here](https://pl

# --- truncated at 32 KB (356 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/anthropic/refs/heads/main/openapi/anthropic-organizations-api-openapi.yml