End every session of an account.

POST

/api/admin/users/{id}/sign-out

const url = 'https://example.com/api/admin/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/sign-out';
const options = {method: 'POST'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/admin/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/sign-out

Parameters

Path Parameters

required

string format: uuid

Responses

200

application/json

object

required

string format: uuid

email

required

null | string

username

required

null | string

displayName

required

string

createdAt

required

string format: date-time

termsVersion

required

null | string

termsAcceptedAt

required

null | string format: date-time

role

required

null | string

hasPassword

required

boolean

twoFactorEnabled

required

boolean

logins

required

Array<string>

suspendedAt

required

null | string format: date-time

suspendedReason

required

null | string

community

required

null | string

profiles

required

Array<object>

object

required

string format: uuid

publicId

required

string

name

required

string

avatar

required

string

kind

required

string

ageBand

required

null | string

createdAt

required

string format: date-time

names

required

Array<object>

object

name

required

string

required

string format: date-time

kind

string

default: rename

onPublicBoards

required

boolean

hiddenFromBoards

required

boolean

deleteAfter

required

null | string format: date-time

Example

{
  "profiles": [
    {
      "names": [
        {
          "kind": "rename"
        }
      ]
    }
  ]
}

404

Not Found