Get the authenticated user's identity | Sample

1 parameter

tokenstringoptional

Authentication token with the `identity.basic` scope; additional identity scopes can provide email or avatar information.

2 status codes

200Returns the authenticated user's `user` object and associated `team` object, with additional identity fields determined by the granted scopes.

defaultTypical error response

callstackstringoptional

Note: PHP callstack is only visible in dev/qa

errorstringrequired

Allowed:not_authedinvalid_authaccount_inactivetoken_revokedno_permissionorg_login_requireduser_is_botinvalid_arg_nameinvalid_array_arginvalid_charsetinvalid_form_datainvalid_post_type

okbooleanrequired

Allowed:false

Error handling

The optional token must provide the identity.basic scope when supplied. The returned identity includes user and team objects, while additional email or avatar details depend on the identity scopes granted to the token.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.usersIdentity.list({ token: "sk_live_4eC39Hq" });

{
  "ok": true,
  "team": {
    "id": "T0G9PQBBK"
  },
  "user": {
    "id": "U0G9QF9C6",
    "name": "Sonny Whether"
  }
}

Request

Response

Errors