KEkeycardai
Delegated Grants

Get delegated grant

Changed on

Returns details of a specific delegated grant by grant ID

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

Path parameters

zoneIdstring required

Zone ID

idstring required

Delegated grant ID

Response

User authorization for a resource to be accessed on their behalf. The grant links the user, resource, and the provider that issued the grant.

idstring required

Unique identifier of the delegated grant

organization_idstring required

Organization that owns this grant

zone_idstring required

Zone this grant belongs to

user_idstring required

Reference to the user granting permission

resource_idstring required

ID of resource receiving grant

provider_idstring required

ID of the provider that issued this grant

scopesstring[] required

Granted OAuth scopes

created_atstring date-time required

Entity creation timestamp

updated_atstring date-time required

Entity update timestamp

expires_atstring date-time required

Date when grant expires

status'active' | 'expired' | 'revoked' required
refreshed_atstring date-time

Timestamp when this grant's tokens were last refreshed. Omitted if grant was never refreshed.

refresh_token_setboolean required

Indicates whether a refresh token is stored for this grant. Grants with refresh tokens can be refreshed even after access token expiration.

activeboolean

Whether the grant is currently active (deprecated - use status instead)

Changes

  • 0cfaff865771Revision changes
    • warning

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

    • warning

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

    • warning

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

    • info

      added the required property // to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

  • d65d51379d93Revision changes
    • info

      added the non-success response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      the //// response's property pattern ^[a-z0-9]+(?:[-_][a-z0-9]+)*$ was added for the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status