Outline · Schema

User

Knowledge BaseWikiDocumentsCollaborationOpen SourceTeam

Properties

Name	Type	Description
id	string	Unique identifier for the object.
name	string	The name of this user, it is migrated from Slack or Google Workspace when the SSO connection is made but can be changed if necessary.
avatarUrl	string	The URL for the image associated with this user, it will be displayed in the application UI and email notifications.
color	string	A color representing the user, used in the UI for avatars without an image.
email	string	The email associated with this user, it is migrated from Slack or Google Workspace when the SSO connection is made but can be changed if necessary.
role	object
isSuspended	boolean	Whether this user has been suspended.
lastActiveAt	string	The last time this user made an API request, this value is updated at most every 5 minutes.
timezone	string	The timezone this user has registered.
createdAt	string	The date and time that this user first signed in or was invited as a guest.
updatedAt	string	The date and time that this user was last updated.
deletedAt	string	The date and time that this user was deleted, if applicable.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "User",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the object.",
      "readOnly": true,
      "format": "uuid"
    },
    "name": {
      "type": "string",
      "description": "The name of this user, it is migrated from Slack or Google Workspace when the SSO connection is made but can be changed if necessary.",
      "example": "Jane Doe"
    },
    "avatarUrl": {
      "type": "string",
      "format": "uri",
      "description": "The URL for the image associated with this user, it will be displayed in the application UI and email notifications."
    },
    "color": {
      "type": "string",
      "description": "A color representing the user, used in the UI for avatars without an image.",
      "readOnly": true
    },
    "email": {
      "type": "string",
      "description": "The email associated with this user, it is migrated from Slack or Google Workspace when the SSO connection is made but can be changed if necessary.",
      "format": "email",
      "readOnly": true
    },
    "role": {
      "$ref": "#/components/schemas/UserRole"
    },
    "isSuspended": {
      "type": "boolean",
      "description": "Whether this user has been suspended.",
      "readOnly": true
    },
    "lastActiveAt": {
      "type": "string",
      "nullable": true,
      "description": "The last time this user made an API request, this value is updated at most every 5 minutes.",
      "readOnly": true,
      "format": "date-time"
    },
    "timezone": {
      "type": "string",
      "nullable": true,
      "description": "The timezone this user has registered."
    },
    "createdAt": {
      "type": "string",
      "description": "The date and time that this user first signed in or was invited as a guest.",
      "readOnly": true,
      "format": "date-time"
    },
    "updatedAt": {
      "type": "string",
      "description": "The date and time that this user was last updated.",
      "readOnly": true,
      "format": "date-time"
    },
    "deletedAt": {
      "type": "string",
      "nullable": true,
      "description": "The date and time that this user was deleted, if applicable.",
      "readOnly": true,
      "format": "date-time"
    }
  }
}