KEkeycardai
Resources

Create resource

Changed on

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

post/zones/{zoneId}/resources

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}/resources
  • Auth
    • HTTP bearer
    • or OAuth 2
      Client credentials
      Token URL: /service-account-token

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

  • 0dee67e0a73aRevision changes
    • info

      added the non-success response with the status

  • 0cfaff865771Revision changes
    • warning

      removed the optional property //// from the response with the status