List identities

GET /api/auth/identity admin

Every identity on the deployment. query searches rather than pages; expand swaps the id-only listing for whole records, which is the difference between one call and one call per row when rendering a table.

Parameters

query string

Search instead of listing. Query parameter.

expand boolean

Return whole identities rather than ids. Query parameter.

cursor string

Continue from a previous page. Query parameter.

limit number

Page size. Query parameter.

Returns

The page of identities, and a cursor when there is more.

Request

curl "https://example.com/api/auth/identity?expand=true&limit=2" \
  -H "authorization: Bearer $TOKEN"

Response

{
  "identities": [
    { "id": "01J2788XY98FDTA410C8S716CD", "kind": "admin", "displayName": "Ada Lovelace" }
  ],
  "cursor": null
}

Read an identity

GET /api/auth/identity/:id session

The identity record.

A missing identity answers 404 — unless the requester is that identity, in which case it answers 401. That is how a deleted account learns its session is worthless instead of being told its own id does not exist.

Parameters

id string Required

Path parameter.

Returns

{ identity }, 404, or 401 for a terminated own account.

Request

curl https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD \
  -H "authorization: Bearer $TOKEN"

Response

{
  "identity": {
    "id": "01J2788XY98FDTA410C8S716CD",
    "kind": "member",
    "displayName": "Ada Lovelace",
    "username": "ada",
    "registered": 1767225600
  }
}

Check whether an identity exists

HEAD /api/auth/identity/:id session

The same read with no body.

Parameters

id string Required

Path parameter.

Returns

200, 404, or 401.

Request

curl -I https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD \
  -H "authorization: Bearer $TOKEN"

Response

{}

Create an identity at a known id

PUT /api/auth/identity/:id session

Reserves the id and writes an identity into it. An id that is already taken answers 409 — this never overwrites, which is what makes it safe to retry.

Parameters

id string Required

The id to claim. Path parameter.

kind enum Required

What the identity is. Missing or unrecognised answers 400.

Possible enum values

guest
member
admin
service
developer

Returns

The created identity. 409 when the id is taken.

Request

curl -X PUT https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD \
  -H "authorization: Bearer $TOKEN" \
  -H "content-type: application/json" \
  -d '{ "kind": "member" }'

Response

{
  "identity": { "id": "01J2788XY98FDTA410C8S716CD", "kind": "member" }
}

Update an identity

POST /api/auth/identity/:id session

Applies whichever fields the body carries. A body with none of them answers 400 rather than quietly succeeding at nothing.

Each field has a route of its own as well; this is the one call that changes several at once.

Parameters

id string Required

Path parameter.

displayName string

The name shown to other people.

email string

The email address on the account.

phone string

The phone number on the account.

username string

The username on the account.

passphrase string

A new passphrase.

kind enum

What the identity is.

Possible enum values

guest
member
admin
service
developer

Returns

A result naming what changed. 400 when the body carries nothing updatable.

Request

curl -X POST https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD \
  -H "authorization: Bearer $TOKEN" \
  -H "content-type: application/json" \
  -d '{ "displayName": "Ada L." }'

Response

{
  "displayName": "Ada L."
}

Terminate an identity

DELETE /api/auth/identity/:id session

Runs termination for the account. An identity that is already gone still has its cache entry swept before the 404, so a half-deleted record cannot linger and keep answering lookups.

Parameters

id string Required

Path parameter.

Returns

200 on termination, 404 when there was nothing to terminate.

Request

curl -X DELETE https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD \
  -H "authorization: Bearer $TOKEN"

Response

{
  "ok": true
}

Read the display name

GET /api/auth/identity/:id/name session

Answers text/plain, not JSON — it is one string, and wrapping it would only give a client something to unwrap.

Parameters

id string Required

Path parameter.

Returns

The display name, as text.

Request

curl https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/name

Response

"Ada Lovelace"

Set the display name

PUT /api/auth/identity/:id/name session

Parameters

id string Required

Path parameter.

displayName string Required

The new name.

Returns

200 once assigned.

Request

curl -X PUT https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/name \
  -H "authorization: Bearer $TOKEN" \
  -H "content-type: application/json" \
  -d '{ "displayName": "Ada L." }'

Response

{
  "ok": true
}

Set the display name (alias)

POST /api/auth/identity/:id/name session

The same handler as PUT, for clients that cannot send one.

Parameters

id string Required

Path parameter.

displayName string Required

The new name.

Returns

200 once assigned.

Request

curl -X POST https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/name \
  -H "authorization: Bearer $TOKEN" \
  -H "content-type: application/json" \
  -d '{ "displayName": "Ada L." }'

Response

{
  "ok": true
}

Remove the display name

DELETE /api/auth/identity/:id/name session

Parameters

id string Required

Path parameter.

Returns

200 once unassigned.

Request

curl -X DELETE https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/name \
  -H "authorization: Bearer $TOKEN"

Response

{
  "ok": true
}

Read the photo

GET /api/auth/identity/:id/photo session

The stored image. An identity with no photo gets a generated SVG avatar rather than a 404, so an <img> pointed at this never has to handle a missing case.

Parameters

id string Required

Path parameter.

Returns

The image, or a fallback image/svg+xml avatar.

Request

curl https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/photo

Response

"<svg xmlns=\"http://www.w3.org/2000/svg\" …>…<\/svg>"

Set the photo

PUT /api/auth/identity/:id/photo session

The request body is the image itself — send the bytes, not a JSON wrapper.

Parameters

id string Required

Path parameter.

body binary Required

The image, with its Content-Type.

Returns

200 once stored.

Request

curl -X PUT https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/photo \
  -H "authorization: Bearer $TOKEN" \
  -H "content-type: image/png" \
  --data-binary @avatar.png

Response

{
  "ok": true
}

Set the photo (alias)

POST /api/auth/identity/:id/photo session

The same handler as PUT.

Parameters

id string Required

Path parameter.

body binary Required

The image bytes.

Returns

200 once stored.

Request

curl -X POST https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/photo \
  -H "authorization: Bearer $TOKEN" \
  -H "content-type: image/png" \
  --data-binary @avatar.png

Response

{
  "ok": true
}

Remove the photo

DELETE /api/auth/identity/:id/photo session

Reverts to the generated avatar.

Parameters

id string Required

Path parameter.

Returns

200 once removed.

Request

curl -X DELETE https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/photo \
  -H "authorization: Bearer $TOKEN"

Response

{
  "ok": true
}

Setting and clearing a passphrase are refused for any session that is not the identity in the path — an admin's included. There is no route here that reads one back; a passphrase is only ever written.

Check whether a passphrase is set

HEAD /api/auth/identity/:id/passphrase session

Readable by any session — it reports that a passphrase exists, not what it is.

Parameters

id string Required

Path parameter.

Returns

200 when set, 404 when not.

Request

curl -I https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/passphrase \
  -H "authorization: Bearer $TOKEN"

Response

{}

Set the passphrase

POST /api/auth/identity/:id/passphrase own identity

403 for a session belonging to anyone else. An empty body answers 400.

Parameters

id string Required

Path parameter.

passphrase string Required

The new passphrase.

Returns

200 once assigned.

Request

curl -X POST https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/passphrase \
  --cookie "identity=$IDENTITY_TOKEN" \
  -H "content-type: application/json" \
  -d '{ "passphrase": "correct-horse-battery-staple" }'

Response

{
  "ok": true
}

Remove the passphrase

DELETE /api/auth/identity/:id/passphrase own identity

403 for a session belonging to anyone else. Leaves the account reachable only by its other methods.

Parameters

id string Required

Path parameter.

Returns

200 once removed.

Request

curl -X DELETE https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/passphrase \
  --cookie "identity=$IDENTITY_TOKEN"

Response

{
  "ok": true
}

Reading, setting and removing a passkey are refused for any session that is not the identity in the path.

Check whether a credential is set

HEAD /api/auth/identity/:id/credential session

Readable by any session — it reports that a passkey exists, not what it is.

Parameters

id string Required

Path parameter.

Returns

200 when set, 404 when not.

Request

curl -I https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/credential \
  -H "authorization: Bearer $TOKEN"

Response

{}

Read the credential

GET /api/auth/identity/:id/credential own identity

403 for a session belonging to anyone else, 404 when none is set.

Parameters

id string Required

Path parameter.

Returns

{ credential }.

Request

curl https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/credential \
  --cookie "identity=$IDENTITY_TOKEN"

Response

{
  "credential": { "id": "AXcv1234", "counter": 3 }
}

Attach a credential

POST /api/auth/identity/:id/credential own identity

Stores the attestation from navigator.credentials.create(). 403 for anyone else, 400 without a credential.

Parameters

id string Required

Path parameter.

credential object Required

The attested credential, as the browser produced it.

2 nested fields

id string

The credential id.

response object

The attestation payload.

Returns

200 once attached.

Request

curl -X POST https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/credential \
  --cookie "identity=$IDENTITY_TOKEN" \
  -H "content-type: application/json" \
  -d '{ "credential": { "id": "AXcv1234", "response": { … } } }'

Response

{
  "ok": true
}

Remove the credential

DELETE /api/auth/identity/:id/credential own identity

403 for a session belonging to anyone else.

Parameters

id string Required

Path parameter.

Returns

200 once removed.

Request

curl -X DELETE https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/credential \
  --cookie "identity=$IDENTITY_TOKEN"

Response

{
  "ok": true
}

Guarded to the identity in the path, an admin's session included. Changing the address a recovery email goes to is not an administrative action — the one exception is POST, which is admin-only precisely because assigning an address without a challenge is.

Check whether an address is set

HEAD /api/auth/identity/:id/email own identity

Parameters

id string Required

Path parameter.

Returns

200 when set, 404 when not.

Request

curl -I https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/email \
  --cookie "identity=$IDENTITY_TOKEN"

Response

{}

Read the address

GET /api/auth/identity/:id/email own identity

Parameters

id string Required

Path parameter.

Returns

{ email }, or 404.

Request

curl https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/email \
  --cookie "identity=$IDENTITY_TOKEN"

Response

{
  "email": "ada@example.com"
}

Assign an address without verifying it

POST /api/auth/identity/:id/email admin

Admin only. Writes the address straight onto the account, skipping the challenge — 403 for anyone else. The verified path is …/email/challenge then …/email/verify.

Parameters

id string Required

Path parameter.

email string Required

The address to assign.

Returns

200 once assigned. 400 without an address.

Request

curl -X POST https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/email \
  -H "authorization: Bearer $TOKEN" \
  -H "content-type: application/json" \
  -d '{ "email": "ada@example.com" }'

Response

{
  "ok": true
}

Remove the address

DELETE /api/auth/identity/:id/email own identity

Parameters

id string Required

Path parameter.

Returns

200 once unassigned.

Request

curl -X DELETE https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/email \
  --cookie "identity=$IDENTITY_TOKEN"

Response

{
  "ok": true
}

Send a verification challenge

POST /api/auth/identity/:id/email/challenge own identity

Mails a challenge to the address, which …/email/verify then redeems. This is the first half of changing the email on an account.

Parameters

id string Required

Path parameter.

address string Required

The address to challenge.

Returns

200.

Request

curl -X POST https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/email/challenge \
  --cookie "identity=$IDENTITY_TOKEN" \
  -H "content-type: application/json" \
  -d '{ "address": "ada@example.com" }'

Response

{
  "ok": true
}

Redeem a verification

POST /api/auth/identity/:id/email/verify own identity

Completes the change begun by …/email/challenge. Omitting address verifies whichever address the account already carries.

Parameters

id string Required

Path parameter.

verification string Required

The token from the challenge email.

address string

The address being verified. Defaults to the account's current one.

Returns

200 when verified, 400 when the token does not match.

Request

curl -X POST https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/email/verify \
  --cookie "identity=$IDENTITY_TOKEN" \
  -H "content-type: application/json" \
  -d '{ "verification": "01J2788XY98FDTA410C8S716CE", "address": "ada@example.com" }'

Response

{
  "ok": true
}

Claims are the arbitrary key–values carried inside the identity token, so anything written here reaches every request that account makes. They are also what GET /api/auth watches: a token minted before a claim changed is refreshed on the next call rather than being left stale.

Read the claims

GET /api/auth/identity/:id/claims admin

Parameters

id string Required

Path parameter.

Returns

{ claims }.

Request

curl https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/claims \
  -H "authorization: Bearer $TOKEN"

Response

{
  "claims": { "plan": "pro", "seats": 5 }
}

Merge into the claims

POST /api/auth/identity/:id/claims admin

A patch. Keys absent from the body keep their values.

Parameters

id string Required

Path parameter.

<claim> any

Any JSON value, under any key.

Returns

{ claims } after the merge.

Request

curl -X POST https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/claims \
  -H "authorization: Bearer $TOKEN" \
  -H "content-type: application/json" \
  -d '{ "plan": "enterprise" }'

Response

{
  "claims": { "plan": "enterprise", "seats": 5 }
}

Replace the claims

PUT /api/auth/identity/:id/claims admin

Wholesale. Anything not in the body is gone from the next token that account is issued.

Parameters

id string Required

Path parameter.

<claim> any

The complete claim set.

Returns

{ claims } as written.

Request

curl -X PUT https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/claims \
  -H "authorization: Bearer $TOKEN" \
  -H "content-type: application/json" \
  -d '{ "plan": "free" }'

Response

{
  "claims": { "plan": "free" }
}

Reset the claims

DELETE /api/auth/identity/:id/claims admin

Back to empty.

Parameters

id string Required

Path parameter.

Returns

{ claims } after the reset.

Request

curl -X DELETE https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/claims \
  -H "authorization: Bearer $TOKEN"

Response

{
  "claims": {}
}

List an identity's OAuth connections

GET /api/auth/identity/:id/connection session

Every provider slot, whether or not it is connected — an unconnected provider is present with no value, which keeps a settings screen from having to know the provider list itself.

Parameters

id string Required

Path parameter.

Returns

{ connections } keyed by provider. 404 when the identity does not exist.

Request

curl https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/connection \
  --cookie "identity=$IDENTITY_TOKEN"

Response

{
  "connections": {
    "google": "104219383929281037492",
    "github": null,
    "apple": null
  }
}

Read one connection

GET /api/auth/identity/:id/connection/:provider session

The provider's account id for this identity. An unknown provider answers 400, a missing identity 404.

Parameters

id string Required

Path parameter.

provider enum Required

Path parameter.

Possible enum values

google
github
apple
twitter
snapchat
twitch

Returns

{ connection }.

Request

curl https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/connection/google \
  --cookie "identity=$IDENTITY_TOKEN"

Response

{
  "connection": "104219383929281037492"
}

Disconnect a provider

DELETE /api/auth/identity/:id/connection/:provider session

Unlinks the provider account. The identity stays; only the link goes.

Parameters

id string Required

Path parameter.

provider enum Required

Path parameter.

Possible enum values

google
github
apple
twitter
snapchat
twitch

Returns

{ identity } as it stands after the unlink.

Request

curl -X DELETE https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/connection/google \
  --cookie "identity=$IDENTITY_TOKEN"

Response

{
  "identity": { "id": "01J2788XY98FDTA410C8S716CD", "kind": "member", "oauth": {} }
}

Read an identity's contact profile

GET /api/auth/identity/:id/contact session

The notification-side record for the account — the row an audience holds when this identity is a member of one.

Parameters

id string Required

Path parameter.

Returns

{ profile }, or 404 when the identity has no contact record.

Request

curl https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/contact \
  --cookie "identity=$IDENTITY_TOKEN"

Response

{
  "profile": {
    "id": "01J2788XY98FDTA410C8S716CD",
    "name": "Ada Lovelace",
    "email": "ada@example.com"
  }
}

List an identity's sessions

GET /api/auth/identity/:id/session session

Every live session for the account — what a "signed in on these devices" list renders from.

Parameters

id string Required

Path parameter.

Returns

{ sessions }.

Request

curl https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/session \
  --cookie "identity=$IDENTITY_TOKEN"

Response

{
  "sessions": [
    { "jti": "01J2788XY98FDTA410C8S716CE", "created": 1767225600, "agent": "Chrome on macOS" }
  ]
}

Invalidate one session

DELETE /api/auth/identity/:id/session session

Ends the session named by jti — this is "sign out my other device". A body without one answers 400.

Parameters

id string Required

Path parameter.

jti string Required

The session to end.

Returns

{ session } as invalidated.

Request

curl -X DELETE https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/session \
  --cookie "identity=$IDENTITY_TOKEN" \
  -H "content-type: application/json" \
  -d '{ "jti": "01J2788XY98FDTA410C8S716CE" }'

Response

{
  "session": { "jti": "01J2788XY98FDTA410C8S716CE", "invalidated": true }
}

Invalidate one session (alias)

POST /api/auth/identity/:id/session session

The same handler as DELETE, for clients that cannot send a body on one.

Parameters

id string Required

Path parameter.

jti string Required

The session to end.

Returns

{ session } as invalidated.

Request

curl -X POST https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/session \
  --cookie "identity=$IDENTITY_TOKEN" \
  -H "content-type: application/json" \
  -d '{ "jti": "01J2788XY98FDTA410C8S716CE" }'

Response

{
  "session": { "jti": "01J2788XY98FDTA410C8S716CE", "invalidated": true }
}

Read one session

GET /api/auth/identity/:id/session/:jti session

Parameters

id string Required

Path parameter.

jti string Required

The session id. Path parameter.

Returns

{ session }.

Request

curl https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/session/01J2788XY98FDTA410C8S716CE \
  --cookie "identity=$IDENTITY_TOKEN"

Response

{
  "session": { "jti": "01J2788XY98FDTA410C8S716CE", "created": 1767225600 }
}

Invalidate one session

DELETE /api/auth/identity/:id/session/:jti session

The same effect as DELETE …/session with a jti body, addressed by URL instead.

Parameters

id string Required

Path parameter.

jti string Required

The session id. Path parameter.

Returns

{ session } as invalidated.

Request

curl -X DELETE https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/session/01J2788XY98FDTA410C8S716CE \
  --cookie "identity=$IDENTITY_TOKEN"

Response

{
  "session": { "jti": "01J2788XY98FDTA410C8S716CE", "invalidated": true }
}

Send an arbitrary notification

POST /api/auth/identity/:id/notification admin

Not implemented. Answers 501. The specific notices below are the ones that work — this route is the general form they were meant to collapse into, and has not been written.

Parameters

id string Required

Path parameter.

Returns

501.

Request

curl -X POST https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/notification \
  -H "authorization: Bearer $TOKEN"

Response

{
  "status": 501,
  "statusText": "Not Implemented"
}

Send the session created notice

POST /api/auth/identity/:id/notification/session/created admin

Tells somebody a new session was opened on their account — the "new sign-in from a new device" mail. The account is addressed by id, so this reaches whichever contact the identity currently carries.

Parameters

id string Required

Path parameter.

jti string Required

The session that was created.

agent string

The browser and platform it was opened from.

created number

When, as a Unix timestamp.

Returns

The send result. 400 when the body is empty — the notice needs something to say.

Request

curl -X POST https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/notification/session/created \
  -H "authorization: Bearer $TOKEN" \
  -H "content-type: application/json" \
  -d '{ "jti": "01J2788XY98FDTA410C8S716CE", "agent": "Chrome on macOS" }'

Response

{
  "sent": true
}

Send the session invalidated notice

POST /api/auth/identity/:id/notification/session/invalidated admin

Tells somebody a session on their account was ended. The account is addressed by id, so this reaches whichever contact the identity currently carries.

Parameters

id string Required

Path parameter.

jti string Required

The session that was ended.

Returns

The send result. 400 when the body is empty — the notice needs something to say.

Request

curl -X POST https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/notification/session/invalidated \
  -H "authorization: Bearer $TOKEN" \
  -H "content-type: application/json" \
  -d '{ "jti": "01J2788XY98FDTA410C8S716CE" }'

Response

{
  "sent": true
}

Send the suspension imposed notice

POST /api/auth/identity/:id/notification/suspension/imposed admin

Tells somebody their account has been suspended, and why. The account is addressed by id, so this reaches whichever contact the identity currently carries.

Parameters

id string Required

Path parameter.

reason string

What to tell them.

until number

When the suspension lifts, as a Unix timestamp.

Returns

The send result. 400 when the body is empty — the notice needs something to say.

Request

curl -X POST https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/notification/suspension/imposed \
  -H "authorization: Bearer $TOKEN" \
  -H "content-type: application/json" \
  -d '{ "reason": "Unusual activity", "until": 1767830400 }'

Response

{
  "sent": true
}

Send the suspension lifted notice

POST /api/auth/identity/:id/notification/suspension/lifted admin

Tells somebody their account is usable again. The account is addressed by id, so this reaches whichever contact the identity currently carries.

Parameters

id string Required

Path parameter.

reason string

What to tell them.

Returns

The send result. 400 when the body is empty — the notice needs something to say.

Request

curl -X POST https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/notification/suspension/lifted \
  -H "authorization: Bearer $TOKEN" \
  -H "content-type: application/json" \
  -d '{ "reason": "Review complete" }'

Response

{
  "sent": true
}

Send the termination warning notice

POST /api/auth/identity/:id/notification/termination/warning admin

Warns somebody their account is scheduled for deletion — the mail that has to arrive before the one below. The account is addressed by id, so this reaches whichever contact the identity currently carries.

Parameters

id string Required

Path parameter.

reason string

What to tell them.

scheduled number

When termination runs, as a Unix timestamp.

Returns

The send result. 400 when the body is empty — the notice needs something to say.

Request

curl -X POST https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/notification/termination/warning \
  -H "authorization: Bearer $TOKEN" \
  -H "content-type: application/json" \
  -d '{ "reason": "Inactive for 24 months", "scheduled": 1767830400 }'

Response

{
  "sent": true
}

Send the termination executed notice

POST /api/auth/identity/:id/notification/termination/executed admin

Tells somebody their account has been deleted. The account is addressed by id, so this reaches whichever contact the identity currently carries.

Parameters

id string Required

Path parameter.

reason string

What to tell them.

Returns

The send result. 400 when the body is empty — the notice needs something to say.

Request

curl -X POST https://example.com/api/auth/identity/01J2788XY98FDTA410C8S716CD/notification/termination/executed \
  -H "authorization: Bearer $TOKEN" \
  -H "content-type: application/json" \
  -d '{ "reason": "Requested by the account holder" }'

Response

{
  "sent": true
}

Guards

Fields have routes

Claims

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters