Retrieve information about oneself

5 status codes

200Successfully retrieved user details.

idstringoptional

The unique identifier of the user.

metaobjectoptional

displayNamestringoptional

the display name of the user

emailsarray<object>optional

localestringoptional

Used to indicate the User's default location for purposes of localizing such items as currency, date time format, or numerical representations.

nameobjectoptional

photosarray<object>optional

The picture of the user. It is expected to have a single item in the context of Grist.

preferredLanguagestringoptional

Indicates the user's preferred written or spoken languages and is generally used for selecting a localized user interface.

schemasarray<string>optional

userNamestringoptional

The unique username.

401Unauthenticated

403Unauthorized

404User not found.

500Internal server error.

Error handling

A 401 is returned: Unauthenticated. A 403 is returned: Unauthorized. A 404 is returned: User not found. A 500 is returned: Internal server error.

import { GristFullAPIOctriPreview } from "grist-octri-preview-sdk";

const client = new GristFullAPIOctriPreview({
  baseUrl: "https://docs.getgrist.com/api",
  auth: { apiKey: process.env.API_TOKEN! },
});

const result = await client.scim.getMe();

{
  "id": "1",
  "meta": {
    "location": "/api/scim/v2/Users/1",
    "resourceType": "User"
  },
  "displayName": "John Doe",
  "emails": [
    {
      "primary": true,
      "value": "john.doe@example.com"
    }
  ],
  "locale": "en",
  "name": {
    "formatted": "John Doe"
  },
  "photos": [
    {
      "primary": true,
      "type": "photo",
      "value": "https://example.com/pics/john-doe.png"
    }
  ],
  "preferredLanguage": "en",
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "userName": "john.doe@example.com"
}

Response

Errors