Synq Docs
Management APIUsers

Change a user

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`.

PATCH/v1/orgs/{org}/brands/{brand}/users/{user}

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.

Authorization

bearer
AuthorizationBearer <token>

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

org*string
brand*string
user*string

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

application/problem+json

curl -X PATCH "https://example.com/v1/orgs/string/brands/string/users/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "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"    }  ]}

List or search a brand's users GET

Newest first. Needs `org.users.view`.

Schedule a user's deletion POST

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`.