Preview retention changes for a page of existing human guests.

POST

/api/admin/account-lifecycle/guest-retention/preview

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/account-lifecycle/guest-retention/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "limit": 100, "cursor": "example" }'

Requires tenant-scoped account-lifecycle settings read permission. Captures account revisions, original creation dates and the current saved policy. A page contains up to 1000 accounts (100 by default). The opaque continuation cursor retains the database inventory and creation cutoff. Previewing never changes accounts. Previews and cursors expire after 15 minutes and become invalid when the saved policy changes.

Authorizations

• adminBearer
• adminSessionCookie

Request Body ^required

Media type application/json

object

limit

integer

default: 100 >= 1 <= 1000

cursor

Opaque continuation cursor from the preceding page.

string

Responses

200

Immutable review page. All timestamps are Unix seconds. A null deadline means automatic deletion is disabled.

Media type application/json

object

preview_token

required

string

expires_at

required

integer

policy_version

required

string

deletion_after_days

required

integer | null

>= 1 <= 3650

count

required

integer

<= 1000

due_now

required

integer

next_cursor

required

string | null

items

required

Array<object>

object

user_id

required

string

created_at

required

integer

previous_due_at

required

integer | null

new_due_at

required

integer | null

Example ^generated

{
  "preview_token": "example",
  "expires_at": 1,
  "policy_version": "example",
  "deletion_after_days": 1,
  "count": 1,
  "due_now": 1,
  "next_cursor": "example",
  "items": [
    {
      "user_id": "example",
      "created_at": 1,
      "previous_due_at": 1,
      "new_due_at": 1
    }
  ]
}

400

Invalid page size or cursor input.

401

Administrator authentication is required.

403

Tenant access or settings read permission is denied.

409

The preview cursor expired or the saved policy changed.

503

The preview service or an assigned database is unavailable.