KEkeycardai
Applications

Get application

Changed on

Returns details of a specific Application by ID

get/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

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