Sign in
Resources

Update resource

Updates a Resource's configuration and metadata

patch/zones/{zoneId}/resources/{id}

Path parameters

zoneIdstring required

Zone ID

idstring required

Resource ID

Request body

namestring

Human-readable name

descriptionstring nullable

Human-readable description

scopesstring[] nullable

Scopes supported by the resource (set to null to unset)

identifierstring

User specified identifier, unique within the zone

credential_provider_idstring nullable

ID of the credential provider to associate with the resource (set to null to unset)

application_idstring 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.

Response

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.

idstring required

Unique identifier of the resource

organization_idstring required

Organization that owns this resource

zone_idstring required

Zone this resource belongs to

slugstring required

URL-safe identifier, unique within the zone

identifierstring required

User specified identifier, unique within the zone

namestring required

Human-readable name

descriptionstring nullable

Human-readable description

scopesstring[] nullable

Scopes supported by the resource

credential_provider_idstring

ID of the credential provider for this resource

application_idstring

ID of the application that provides this resource

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.

when_accessingstring[]

List of resource IDs that, when accessed, make this dependency available. Only present when this resource is returned as a dependency.

owner_type'platform' | 'customer' required

Who owns this resource. Platform-owned resources cannot be modified via API.

created_atstring date-time required

Entity creation timestamp

updated_atstring date-time required

Entity update timestamp

Changes