---
title: "Update resource"
method: PATCH
path: "/zones/{zoneId}/resources/{id}"
tags: ["Resources"]
---

# Update resource

`PATCH /zones/{zoneId}/resources/{id}`

Updates a Resource's configuration and metadata

## Path parameters

- `zoneId` string, required
- `id` string, required

## Request body

- IamResourceUpdate — Schema for updating an existing resource (partial update). **Warning:** Changing the `identifier` field may break existing integrations and dependencies.
  - `name` string, safe-text — Human-readable name. Must not contain HTML tags (e.g. `<script>`, `<div>`) or control characters.
  - `description` string, safe-text, nullable — Human-readable description. Must not contain HTML tags (e.g. `<script>`, `<div>`) or control characters.
  - `scopes` string[], nullable — Scopes supported by the resource (set to null to unset)
  - `identifier` string, safe-text — User specified identifier, unique within the zone. Must not contain HTML tags (e.g. `<script>`, `<div>`) or control characters.
  - `credential_provider_id` string, nullable — ID of the credential provider to associate with the resource (set to null to unset)
  - `application_id` string, nullable — ID of the application that provides this resource (set to null to unset)
  - `application_type` 'native' | 'web' — The expected type of client for this credential. Native clients must use localhost URLs for redirect_uris or URIs with custom schemes. Web clients must use https URLs and must not use localhost as the hostname.
  - `prefix` boolean — When true, the resource identifier is treated as a URI prefix, protecting all URLs that share the identifier as a prefix.
  - `credential_lifetime_seconds` integer, nullable — Credential lifetime override in seconds. Set to null to clear the override and use the default.
  - `metadata` IamMetadataUpdate, nullable — Entity metadata (set to null or {} to remove metadata)
    - `docs_url` string, uri, nullable — Documentation URL (set to null to unset)
    - `icon_url` string, uri, nullable — Icon URL (set to null to unset)

## Response `200`

A Resource is a system that exposes protected information or functionality. It requires authentication of the requesting actor, which may be a user or application, before allowing access.

- IamResource — A Resource is a system that exposes protected information or functionality. It requires authentication of the requesting actor, which may be a user or application, before allowing access.
  - `id` string, required — Unique identifier of the resource
  - `organization_id` string, required — Organization that owns this resource
  - `zone_id` string, required — Zone this resource belongs to
  - `slug` string, required — URL-safe identifier, unique within the zone
  - `identifier` string, required — User specified identifier, unique within the zone
  - `name` string, required — Human-readable name
  - `description` string, nullable — Human-readable description
  - `scopes` string[], nullable — Scopes supported by the resource
  - `credential_provider_id` string — ID of the credential provider for this resource
  - `credential_provider` IamProvider — A Provider is a system that supplies access to Resources and allows actors (Users or Applications) to authenticate.
    - `id` string, required — Unique identifier of the provider
    - `organization_id` string, required — Organization that owns this provider
    - `zone_id` string, required — Zone this provider belongs to
    - `slug` string, required — URL-safe identifier, unique within the zone
    - `name` string, required — Human-readable name
    - `description` string, nullable — Human-readable description
    - `identifier` string, required — User specified identifier, unique within the zone
    - `type` 'external' | 'keycard-vault' | 'keycard-sts'
    - `client_id` string, nullable — OAuth 2.0 client identifier
    - `client_secret_set` boolean — Indicates whether a client secret is configured
    - `protocols` object, nullable — Protocol-specific configuration
      - `oauth2` IamProviderOAuth2Protocol, nullable — OAuth 2.0 protocol configuration
        - `issuer` string, uri, required — OIDC issuer URL used for discovery and token validation.
        - `authorization_endpoint` string, uri, nullable
        - `token_endpoint` string, uri, nullable
        - `registration_endpoint` string, uri, nullable
        - `jwks_uri` string, uri, nullable
        - `code_challenge_methods_supported` string[], nullable
        - `scopes_supported` string[], nullable
        - `authorization_resource_enabled` boolean, nullable — Whether to include the resource parameter in authorization requests.
        - `authorization_resource_parameter` string, nullable — The resource parameter value to include in authorization requests. Defaults to "resource" when authorization_resource_enabled is true.
        - `scope_parameter` string, nullable — The query parameter name for scopes in authorization requests. Defaults to "scope". Slack v2 uses "user_scope".
        - `scope_separator` string, nullable — The separator character for scope values. Defaults to " " (space). Slack v2 uses ",".
        - `token_response_access_token_pointer` string, nullable — Dot-separated path to the access token in the token response body. Defaults to "access_token". Slack v2 uses "authed_user.access_token".
        - `authorization_parameters` object, nullable — Custom query parameters appended to authorization redirect URLs. Use for non-standard providers (e.g. Google prompt=consent, access_type=offline).
      - `openid` IamProviderOpenIDProtocol, nullable — OpenID Connect protocol configuration
        - `userinfo_endpoint` string, uri, nullable
        - `user_identifier_claim` string, nullable — Name of a top-level string claim in this provider's ID Token to use as the user identifier on user creation. When not set, the user's Keycard ID is used.
        - `external_id_claim` string, nullable — Name of the OIDC claim carrying the stable external id used to correlate logins with externally provisioned (SCIM) users. Defaults to "sub". Set to "oid" for Entra, whose pairwise "sub" differs from the SCIM externalId.
        - `scopes` string[], nullable — Additional OIDC scopes to request from this provider during authentication (e.g. "groups"). Merged with the default scopes (openid, profile, email).
        - `single_logout_enabled` boolean, nullable — When true, logging out of the zone propagates the logout to this provider's end_session_endpoint (RP-initiated logout). Defaults to false.
    - `metadata` object, nullable — Provider metadata
      - `icon_url` string, uri — Icon URL
    - `owner_type` 'platform' | 'customer', required — Who owns this provider. Platform-owned providers cannot be modified via API.
    - `created_at` string, date-time, required — Entity creation timestamp
    - `updated_at` string, date-time, required — Entity update timestamp
  - `application_id` string — ID of the application that provides this resource
  - `application` IamApplication — An Application is a software system with an associated identity that can access Resources. It may act on its own behalf (machine-to-machine) or on behalf of a user (delegated access).
    - `id` string, required — Unique identifier of the application
    - `organization_id` string, required — Organization that owns this application
    - `zone_id` string, required — Zone this application belongs to
    - `slug` string, required — URL-safe identifier, unique within the zone
    - `identifier` string, required — User specified identifier, unique within the zone
    - `name` string, required — Human-readable name
    - `description` string, nullable — Human-readable description
    - `metadata` IamMetadata — Entity metadata
      - `docs_url` string, uri — Documentation URL
      - `icon_url` string, uri — Icon URL
    - `protocols` object, nullable — Protocol-specific configuration
      - `oauth2` IamApplicationOAuth2Protocol, nullable — OAuth 2.0 protocol configuration
        - `redirect_uris` string[], nullable — OAuth 2.0 redirect URIs for this application
        - `post_logout_redirect_uris` string[], nullable — OAuth 2.0 post-logout redirect URIs for this application
    - `dependencies_count` integer, required — Number of resource dependencies
    - `owner_type` 'platform' | 'customer', required — Who owns this application. Platform-owned applications cannot be modified via API.
    - `consent` 'implicit' | 'required', required — Consent mode for the application. 'implicit' means consent is automatically granted, 'required' means explicit user consent is needed.
    - `created_at` string, date-time, required — Entity creation timestamp
    - `updated_at` string, date-time, required — Entity update timestamp
  - `application_type` 'native' | 'web', required — The expected type of client for this credential. Native clients must use localhost URLs for redirect_uris or URIs with custom schemes. Web clients must use https URLs and must not use localhost as the hostname.
  - `prefix` boolean, required — When true, the resource identifier is treated as a URI prefix, protecting all URLs that share the identifier as a prefix at path/query/fragment boundaries. Protocol and hostname must match exactly. When multiple prefix resources satisfy an identifier query, the resource with the longest prefix is matched.
  - `credential_lifetime_seconds` integer, nullable — Credential lifetime override in seconds. When set, overrides the default credential lifetime for this resource. When absent, the default from the provider or zone is used.
  - `when_accessing` string[] — List of resource IDs that, when accessed, make this dependency available. Only present when this resource is returned as a dependency.
  - `metadata` IamMetadata — Entity metadata
    - `docs_url` string, uri — Documentation URL
    - `icon_url` string, uri — Icon URL
  - `owner_type` 'platform' | 'customer', required — Who owns this resource. Platform-owned resources 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

- `400` — Error response
- `403` — Error response
- `404` — Error response
- `409` — Error response
- `default` — Error response

## Changes

- **2026-08-26** `d65d51379d93` — 6 info
  - added the non-success response with the status `400`
  - added the non-success response with the status `403`
  - added the non-success response with the status `404`
  - added the non-success response with the status `409`
  - …2 more
- **2026-07-01** `2f5033ed4491` — 4 info
  - added the new optional request property `metadata/icon_url`
  - added the optional property `application/allOf[subschema #1: Application]/metadata/icon_url` to the response with the `200` status
  - added the optional property `credential_provider/allOf[subschema #1: Provider]/protocols/openid/single_logout_enabled` to the response with the `200` status
  - added the optional property `metadata/allOf[#/components/schemas/iam_Metadata]/icon_url` to the response with the `200` status
- **2026-05-22** `ffb6f697525f` — 1 info
  - added the optional property `credential_provider/allOf[subschema #1: Provider]/protocols/openid/scopes` to the response with the `200` status
- **2026-05-18** `2861899ae69e` — 2 info
  - added the new optional request property `credential_lifetime_seconds`
  - added the optional property `credential_lifetime_seconds` to the response with the `200` status
- **2026-04-24** `fcab5a5e6cd0` — 2 info
  - added the new optional request property `prefix`
  - added the required property `prefix` to the response with the `200` status

[Full history](https://skmtc.dev/keycardai/apis/untitled-api/changes/zones/:zoneId/resources/:id/patch.md)

---

[API](https://skmtc.dev/keycardai/apis/untitled-api.md) · [All operations](https://skmtc.dev/keycardai/apis/untitled-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/keycardai/untitled-api/revisions/d65d51379d93/schema)