---
title: "Get zone"
method: GET
path: "/zones/{zoneId}"
tags: ["Zones"]
---

# Get zone

`GET /zones/{zoneId}`

## Request

- Base URL: `https://docs.keycard.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://docs.keycard.ai/zones/{zoneId}`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Client credentials
    - Token URL: `/service-account-token`

Returns details of a specific zone by ID

## Path parameters

- `zoneId` string, required

## Query parameters

- `expand[]` union
  - 'permissions'
  - string[]

## Response `200`

A zone for organizing resources within an organization

- IamZone: A zone for organizing resources within an organization
  - `id` string, required: Unique identifier of the zone
  - `organization_id` string, required: Organization that owns this zone
  - `slug` string, required: URL-safe identifier, unique within the zone
  - `name` string, required: Human-readable name
  - `description` string, nullable: Human-readable description
  - `user_identity_provider_id` string: Provider ID configured for user login
  - `external_sync_enabled` boolean, required: Whether external directory sync (SCIM) is enabled for this zone. Required to create external sync tokens.
  - `protocols` object, required: Protocol configuration for a zone
    - `oauth2` IamZoneOAuth2Protocol, required: OAuth 2.0 protocol configuration for a zone
      - `issuer` string, uri, required: OAuth 2.0 issuer identifier
      - `authorization_server_metadata` string, uri, required: OAuth 2.0 Authorization Server Metadata endpoint (.well-known/oauth-authorization-server)
      - `authorization_endpoint` string, uri, required: OAuth 2.0 authorization endpoint
      - `token_endpoint` string, uri, required: OAuth 2.0 token endpoint
      - `redirect_uri` string, uri, required: OAuth 2.0 redirect URI for this zone
      - `registration_endpoint` string, uri, required: OAuth 2.0 Dynamic Client Registration endpoint
      - `jwks_uri` string, uri, required: JSON Web Key Set endpoint
      - `pkce_required` boolean, required: Whether PKCE is required for authorization code flows
      - `dcr_enabled` boolean, required: Whether Dynamic Client Registration is enabled
      - `cimd` IamZoneCimd, required: Client ID Metadata Document auto-provisioning configuration
        - `enabled` boolean, required: Whether CIMD auto-provisioning is enabled for unregistered URL-based clients
        - `allowed_client_ids` string[], required: Allowlist for CIMD client_id URLs. Each entry is an exact URL, a wildcard origin with a single * replacing one subdomain label (e.g. https://*.example.com matches https://app.example.com but not https://a.b.example.com), or the literal * to allow any client. Only one * is permitted per entry.
    - `openid` IamZoneOpenIDProtocol, required: OpenID Connect protocol configuration for a zone
      - `provider_configuration` string, uri, required: OpenID Connect Provider Configuration endpoint (.well-known/openid-configuration)
      - `userinfo_endpoint` string, uri, required: OpenID Connect UserInfo endpoint
  - `encryption_key` IamEncryptionKeyAwsKmsConfig: AWS KMS configuration for zone encryption. When not specified, the default Keycard Cloud encryption key will be used.
    - `type` 'aws', required
    - `arn` string, required: AWS KMS Key ARN for encrypting the zone's data
  - `default_mcp_gateway_application_id` string: Application ID configured as the default MCP Gateway for the zone
  - `default_resource_id` string: Resource ID configured as the default resource for the zone
  - `permissions` IamPermissions: Permissions granted to the authenticated principal. Only populated when expand[]=permissions query parameter is provided. Keys are resource types, values are objects mapping action names to boolean values.
  - `owner_type` 'platform' | 'customer', required: Who owns this zone. Platform-owned zones cannot be modified via API.
  - `created_at` string, date-time, required: Entity creation timestamp
  - `updated_at` string, date-time, required: Entity update timestamp

## Other responses

- `default`: Error response

## Changes

- **2026-10-29** `0dee67e0a73a`: 1 warning
  - removed the optional property `requires_invitation` from the response with the `200` status
- **2026-10-16** `0cfaff865771`: 1 info
  - added the required property `external_sync_enabled` to the response with the `200` status
- **2026-06-09** `7e0e4fa2e16f`: 1 info
  - added the required property `owner_type` to the response with the `200` status
- **2026-05-18** `2861899ae69e`: 1 warning, 1 info
  - removed the optional property `login_flow` from the response with the `200` status
  - added the required property `protocols/oauth2/cimd` to the response with the `200` status
- **2026-04-02** `aee6e66de0d3`: 1 info
  - added the optional property `default_resource_id` to the response with the `200` status

[Operation history](https://skmtc.dev/keycardai/apis/keycard-ai-keycard-api/changes/zones/:zoneId/get.md)

---

[API](https://skmtc.dev/keycardai/apis/keycard-ai-keycard-api.md) - [All operations](https://skmtc.dev/keycardai/apis/keycard-ai-keycard-api/llms.txt) - [OpenAPI document](https://skmtc.dev/keycardai/apis/keycard-ai-keycard-api/revisions/0dee67e0a73a?raw)