Sign in
Delegated Grants

Update delegated grant

Revokes an active delegated grant

patch/zones/{zoneId}/delegated-grants/{id}

Path parameters

zoneIdstring required

Zone ID

idstring required

Delegated grant ID

Request body

status'revoked' required

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

Changed in 15 of the 23 revisions of this API.3654

  • d65d51379d9312See 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 optional property provider/allOf[subschema #1: Provider]/metadata/icon_url to the response with the 200 status

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

      added the optional property user/allOf[subschema #1: User]/credentials to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property user/allOf[subschema #1: User]/groups to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property user/allOf[subschema #1: User]/role_assignments/items/group_id to the response with the 200 status

      response-optional-property-added

    • ○

      the user/allOf[subschema #1: User]/role_assignments/items/role_identifier response's property pattern ^[a-z0-9]+(?:[-_][a-z0-9]+)*$ was added for the status 200

      response-property-pattern-added

    • ○

      added the required property user/allOf[subschema #1: User]/role_assignments/items/role_owner_type to the response with the 200 status

      response-required-property-added

    • ○

      added the required property user/allOf[subschema #1: User]/role_assignments/items/source to the response with the 200 status

      response-required-property-added

  • 2f5033ed44914See the full diff
    • ○

      added the optional property 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 resource/allOf[subschema #1: Resource]/application/allOf[subschema #1: Application]/metadata/icon_url to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property resource/allOf[subschema #1: Resource]/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 resource/allOf[subschema #1: Resource]/metadata/allOf[iam_Metadata]/icon_url to the response with the 200 status

      response-optional-property-added

  • 1a0dd4d857ee1See the full diff
    • ○

      added the required property user/allOf[subschema #1: User]/status to the response with the 200 status

      response-required-property-added

  • 7e0e4fa2e16f1See the full diff
    • ○

      added the optional property user/allOf[subschema #1: User]/role_assignments to the response with the 200 status

      response-optional-property-added

  • ffb6f697525f4See the full diff
    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

      added the optional property user/allOf[subschema #1: User]/grant_count to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property user/allOf[subschema #1: User]/session_count to the response with the 200 status

      response-optional-property-added

  • 2861899ae69e1See the full diff
    • ○

      added the optional property resource/allOf[subschema #1: Resource]/credential_lifetime_seconds to the response with the 200 status

      response-optional-property-added

  • fcab5a5e6cd01See the full diff
    • ○

      added the required property resource/allOf[subschema #1: Resource]/prefix to the response with the 200 status

      response-required-property-added

  • 932699a5ea161See the full diff
    • ○

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

      response-required-property-added

  • aee6e66de0d33See the full diff
    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

      added the required property user/allOf[subschema #1: User]/identifier to the response with the 200 status

      response-required-property-added

  • d3d69f45bfed13See the full diff
    • ●

      removed the optional property resource/allOf[subschema #1: Resource]/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