Assume an identity — act as a customer account

POST

/admin/assume

Needs assume. Mints a bearer token that is the customer's: every
route sees them. Read mode sees what they see and changes nothing.
Write mode may also change the areas the caller's own admin scopes
cover — billing for billing, resources for provisioning, users
for the profile, teams and family — and never more: the identity itself
(sessions, MFA, password) is never writable, and nothing under /admin
answers. Assuming an admin account needs grant-admin, and still buys
no admin powers.

The token is a session of the customer's, marked with who really holds
it and why; they see it under Security → Sessions and can end it, and
they are emailed when it opens — the role, the mode, the reason and
when it ends, never the admin's address. The caller's power to assume
is re-checked on every request, so losing it ends every assumed token
at once. Every write under an assumed identity is audited against the
admin.

Request

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

The token, and what it may do

Bodyapplication/json

🟠400

🟠403

🟠404NotFound

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.prod-orm.io/admin/assume' \
--header 'Content-Type: application/json' \
--data '{
    "userId": 0,
    "mode": "read",
    "minutes": 60,
    "reason": "string"
}'

Response Example

201 - Example 1

{
    "token": "string",
    "expiresAt": "2019-08-24T14:15:22.123Z",
    "mode": "read",
    "user": {
        "id": 0,
        "email": "user@example.com",
        "username": "string",
        "fname": "string",
        "lname": "string",
        "fullname": "string",
        "age": 0,
        "role": "admin",
        "birthday": "2019-08-24",
        "guardian": {
            "email": "user@example.com",
            "username": "string",
            "relationship": "parent",
            "approved": true
        },
        "emancipatedAt": "2019-08-24T14:15:22.123Z",
        "restrictions": {
            "provisioning": true,
            "signin": true
        },
        "verified": true
    },
    "writable": [
        "string"
    ]
}

Modified at 2026-10-05 04:04:32

Remove a member

The identities the caller holds open