Synq Docs
Account APIProfile

Change the signed-in person's profile

Their username, names, picture and language; null clears one. Not their email, which a sign-in method proves. Needs `me:write`. Recorded as `user.updated`.

PATCH/v1/profile

Their username, names, picture and language; null clears one. Not their email, which a sign-in method proves. Needs me:write. Recorded as user.updated.

Authorization

bearer
AuthorizationBearer <token>

An access token from this issuer for its account API (resource=<issuer>/me).

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X PATCH "https://example.com/v1/profile" \  -H "Content-Type: application/json" \  -d '{}'
{  "sub": "string",  "email": "string",  "email_verified": true,  "username": "string",  "name": "string",  "given_name": "string",  "family_name": "string",  "picture": "string",  "locale": "string",  "deletion_scheduled_for": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z"}

Read the signed-in person's profile GET

Needs `me:read`.

Sign out of one session DELETE

Ends it and every grant it made: its refresh tokens stop working. Each app the session had signed in to that registered a `backchannel_logout_uri` gets a logout token; one that turned `backchannel_logout_session_required` off gets it without `sid`, so it signs the person out of every session it has. Needs `me:write`. Recorded as `user.sessions_revoked`.