KEkeycardai
Applications

Update application

Changed on

Updates an Application's configuration and metadata

patch/zones/{zoneId}/applications/{id}

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

Path parameters

zoneIdstring required
idstring required

Request body

namestring safe-text

Human-readable name. 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.

identifierstring safe-text

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

consent'implicit' | 'required'

Consent mode for the application. 'implicit' means consent is automatically granted, 'required' means explicit user consent is needed.

Response

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

idstring required

Unique identifier of the application

organization_idstring required

Organization that owns this application

zone_idstring required

Zone this application 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

dependencies_countinteger 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_atstring date-time required

Entity creation timestamp

updated_atstring date-time required

Entity update timestamp

Changes

  • d65d51379d93Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 2f5033ed4491Revision changes
    • info

      added the new optional request property /

    • info

      added the optional property / to the response with the status