Schedule a user's deletion
The account is deleted 30 days later; it is signed out at once, every session and grant ended, offline and device ones included, and can’t sign in meanwhile. Each app the sessions had signed in to that registered a `backchannel_logout_uri` gets a logout token. Needs `org.users.edit`. Recorded as `user.deletion_scheduled`.
/v1/orgs/{org}/brands/{brand}/users/{user}/deletionThe account is deleted 30 days later; it is signed out at once, every session and grant ended, offline and device ones included, and can’t sign in meanwhile. Each app the sessions had signed in to that registered a backchannel_logout_uri gets a logout token. Needs org.users.edit. Recorded as user.deletion_scheduled.
Authorization
bearer An org API key (sk_live_…, sk_test_…), or an access token from the Synq issuer (the synq brand, on the accounts host) for this API.
In: header
Path Parameters
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/v1/orgs/string/brands/string/users/string/deletion"{ "id": "string", "email": "string", "email_verified": true, "username": "string", "name": "string", "given_name": "string", "family_name": "string", "picture": "string", "locale": "string", "wallets": [ "string" ], "disabled": true, "deletion_scheduled_for": "2019-08-24T14:15:22Z", "last_sign_in_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "metadata": { "property1": null, "property2": null }, "identities": [ { "id": "string", "provider": "string", "subject": "string", "handle": "string", "details": { "account_type": "string", "created_at": "2019-08-24T14:15:22Z", "public_repos": 0, "followers": 0, "email_verified": true, "workspace_domain": "string", "test": true }, "details_read_at": "2019-08-24T14:15:22Z", "label": "string", "primary": true, "last_used_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z" } ], "sessions": [ { "id": "string", "signed_in_at": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z", "apps": [ "string" ], "via": "hosted" } ]}Change a user PATCH
Their profile, the tenant's metadata (the whole object), or whether they are disabled; null clears a field. Disabling signs them out at once, ending every session and grant, offline and device ones included. Each app the sessions had signed in to that registered a `backchannel_logout_uri` gets a logout token. Needs `org.users.edit`. Recorded as `user.updated`.
End a user's sessions POST
Every session and every grant, offline and device ones included: their refresh tokens stop working, a sign-in already in flight is refused, and they sign in again. Each app the sessions had signed in to that registered a `backchannel_logout_uri` gets a logout token. JWT access tokens for the brand's APIs work until they expire (5 to 15 minutes). Needs `org.users.edit`. Recorded as `user.sessions_revoked`.