User-related API environment

Pre-live user-related API docs

These pages describe the Pre-live user-related API stack.

Use pre-live OAuth credentials, pre-live API base URLs, and pre-live app URLs when following this documentation. Keep your OAuth flow, API requests, callback URLs, and manual testing within the pre-live environment.

• Use prelive.quran.com for auth-related testing.
• Use prelive.quranreflect.org for Quran Reflect paths where applicable.
• Do not mix production sessions or production user data with pre-live testing.

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.

application/json

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

• 200
• 400
• 401
• 403
• 404
• 409
• 413
• 500
• 503

---

Overall and per-step lifecycle progress without internal identifiers.

application/json

Schema

Example (from schema)

Example

---

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

{
  "success": true,
  "data": {
    "requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "action": "REVOKE",
    "status": "string",
    "retryable": true,
    "progress": {
      "revoke": {
        "status": "string",
        "total": 0,
        "completed": 0,
        "failed": 0,
        "attemptCount": 0
      },
      "deleteData": {
        "status": "not_requested",
        "deleted": true
      }
    }
  }
}

{
  "success": true,
  "data": {
    "requestId": "123e4567-e89b-12d3-a456-426614174000",
    "action": "REVOKE",
    "status": "string",
    "retryable": true,
    "progress": {
      "revoke": {
        "status": "string",
        "total": 1,
        "completed": 1,
        "failed": 1,
        "attemptCount": 1
      },
      "deleteData": {
        "status": "not_requested",
        "deleted": true
      }
    }
  }
}

The Connected Apps operation was rejected or could not be completed.

application/json

Schema

Example (from schema)

Example

---

Schema

success boolean required

Possible values: [false]

error object required
code string required
message string required
details object
property name* any

{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

A valid Quran.com user session is required.

A valid CSRF token is required for this lifecycle action.

The Connected Apps operation was rejected or could not be completed.

application/json

Schema

Example (from schema)

Example

---

Schema

success boolean required

Possible values: [false]

error object required
code string required
message string required
details object
property name* any

{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

The lifecycle request conflicts with current or durable operation state.

application/json

Schema

Example (from schema)

Connected app precondition failed

Lifecycle request ID reused

---

Schema

success boolean required

Possible values: [false]

error object required
code string required
message string required
details object
property name* any

{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "connected_app_precondition_failed",
    "message": "The connected app changed after this page was loaded. Refresh and try again."
  }
}

{
  "success": false,
  "error": {
    "code": "lifecycle_request_id_reused",
    "message": "The lifecycle request ID was reused for a different request."
  }
}

The lifecycle request body exceeds the JSON request limit.

application/json

Schema

Example (from schema)

Lifecycle request too large

---

Schema

success boolean required

Possible values: [false]

error object required
code string required
message string required
details object
property name* any

{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "invalid_lifecycle_request",
    "message": "The lifecycle request body is too large."
  }
}

The Connected Apps operation was rejected or could not be completed.

application/json

Schema

Example (from schema)

Example

---

Schema

success boolean required

Possible values: [false]

error object required
code string required
message string required
details object
property name* any

{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

The Connected Apps operation was rejected or could not be completed.

application/json

Schema

Example (from schema)

Example

---

Schema

success boolean required

Possible values: [false]

error object required
code string required
message string required
details object
property name* any

{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

Loading...