Sign in
Resources

Create resource

Creates a new Resource - a system that exposes protected information or functionality requiring authentication

post/zones/{zoneId}/resources

Path parameters

zoneIdstring required

Zone ID

Request body

namestring safe-text required

Human-readable name. Must not contain HTML tags (e.g. <script>, <div>) or control characters.

identifierstring safe-text required

User specified identifier, unique within the zone. Must not contain HTML tags (e.g. <script>, <div>) or control characters.

descriptionstring safe-text nullable

Human-readable description. Must not contain HTML tags (e.g. <script>, <div>) or control characters.

scopesstring[]

Scopes supported by the resource

credential_provider_idstring

ID of the credential provider to associate with the resource

application_idstring

ID of the application that provides this resource

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.

prefixboolean

When true, the resource identifier is treated as a URI prefix and protects all URLs that share the identifier as a prefix. Defaults to false: resources only match by exact identifier unless explicitly enabled.

credential_lifetime_secondsinteger

Credential lifetime override in seconds. When set, overrides the default credential lifetime for this resource.

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.

prefixboolean 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_secondsinteger 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_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

Changed in 11 of the 23 revisions of this API.5432

  • d65d51379d935See the full diff
    • ○

      added the non-success response with the status 400

      response-non-success-status-added

    • ○

      added the non-success response with the status 404

      response-non-success-status-added

    • ○

      added the non-success response with the status 409

      response-non-success-status-added

    • ○

      added the optional property credential_provider/allOf[subschema #1: Provider]/metadata/icon_url to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property credential_provider/allOf[subschema #1: Provider]/protocols/openid/external_id_claim to the response with the 200 status

      response-optional-property-added

  • 2f5033ed449114See the full diff
    • ▲

      the scopes/items/ request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • ○

      added the new optional request property metadata/icon_url

      new-optional-request-property

    • ○

      added the optional property application/allOf[subschema #1: Application]/metadata/icon_url to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property credential_provider/allOf[subschema #1: Provider]/protocols/openid/single_logout_enabled to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property metadata/allOf[iam_Metadata]/icon_url to the response with the 200 status

      response-optional-property-added

  • ffb6f697525f1See the full diff
    • ○

      added the optional property credential_provider/allOf[subschema #1: Provider]/protocols/openid/scopes to the response with the 200 status

      response-optional-property-added

  • 2861899ae69e2See the full diff
    • ○

      added the new optional request property credential_lifetime_seconds

      new-optional-request-property

    • ○

      added the optional property credential_lifetime_seconds to the response with the 200 status

      response-optional-property-added

  • fcab5a5e6cd02See the full diff
    • ○

      added the new optional request property prefix

      new-optional-request-property

    • ○

      added the required property prefix to the response with the 200 status

      response-required-property-added

  • 932699a5ea1631See the full diff
    • ▲

      the description request property type/format changed from string/ to string/safe-text

      request-property-type-changed

    • ▲

      the identifier request property type/format changed from string/ to string/safe-text

      request-property-type-changed

    • ▲

      the name request property type/format changed from string/ to string/safe-text

      request-property-type-changed

    • ○

      added the required property application/allOf[subschema #1: Application]/consent to the response with the 200 status

      response-required-property-added

  • aee6e66de0d31See the full diff
    • ○

      added the optional property credential_provider/allOf[subschema #1: Provider]/protocols/openid/user_identifier_claim to the response with the 200 status

      response-optional-property-added

  • d3d69f45bfed13See the full diff
    • ●

      removed the optional property application/allOf[subschema #1: Application]/traits from the response with the 200 status

      response-optional-property-removed

    • ○

      the endpoint scheme security OAuth2 was added to the API

      api-security-added

    • ○

      the endpoint scheme security bearerAuth was added to the API

      api-security-added

    • ○

      the endpoint scheme security iam_bearerAuth was removed from the API

      api-security-removed

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • cb43483cd1b3118See the full diff
    • ▲

      the metadata response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ●

      removed the optional property metadata/docs_url from the response with the 200 status

      response-optional-property-removed

    • ○

      added the new optional request property application_type

      new-optional-request-property

    • ○

      added the optional property credential_provider/allOf[subschema #1: Provider]/protocols/oauth2/authorization_parameters to the response with the 200 status

      response-optional-property-added

    • ○

      added iam_Metadata to the metadata response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      added the required property application/allOf[subschema #1: Application]/owner_type to the response with the 200 status

      response-required-property-added

    • ○

      added the required property application_type to the response with the 200 status

      response-required-property-added

    • ○

      added the required property credential_provider/allOf[subschema #1: Provider]/owner_type to the response with the 200 status

      response-required-property-added

    • ○

      added the required property credential_provider/allOf[subschema #1: Provider]/protocols/oauth2/issuer to the response with the 200 status

      response-required-property-added

    • ○

      added the required property owner_type to the response with the 200 status

      response-required-property-added

  • 0aa1f5c87e813See the full diff
    • ○

      added the optional property credential_provider/allOf[subschema #1: Provider]/protocols/oauth2/scope_parameter to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property credential_provider/allOf[subschema #1: Provider]/protocols/oauth2/scope_separator to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property credential_provider/allOf[subschema #1: Provider]/protocols/oauth2/token_response_access_token_pointer to the response with the 200 status

      response-optional-property-added