Skip to main content

User-related API environment

Production user-related API docs

These pages describe the Production user-related API stack.

Use production OAuth credentials, production API base URLs, and production app URLs when following this documentation.

Need to test before going live? Switch to the Pre-live docs using the environment switcher above.

Run a connected-app lifecycle action​

Revokes the authenticated user’s consent for every linked OAuth client, deletes the shared App State namespace once, or performs both in order. Exact retries reuse the same high-entropy request ID.

Path Parameters
    appId uuid required
Header Parameters
    X-CSRF-Token string required

    CSRF token associated with the authenticated browser session.

Request Body required
    action string required

    Possible values: [REVOKE, DELETE_DATA, REVOKE_AND_DELETE]

    requestId uuid required

    Possible values: Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89aAbB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

    High-entropy UUIDv4 reused for exact retries.

    expectedAppId uuid

    Optional app identity copied from the inventory page to reject stale destructive actions.

    environment string

    Possible values: [prelive, production]

    Optional app environment copied from the inventory page to reject stale destructive actions.

Responses

Overall and per-step lifecycle progress without internal identifiers.

Schema
    success boolean required

    Possible values: [true]

    data object required
    requestId uuid required
    action string required

    Possible values: [REVOKE, DELETE_DATA, REVOKE_AND_DELETE]

    status string required
    retryable boolean required
    progress object required
    revoke object required
    status string required
    total integer
    completed integer
    failed integer
    attemptCount integer
    deleteData object required
    status string required

    Possible values: [not_requested, completed]

    deleted boolean
Loading...