Open in Claude Open in ChatGPT

Domain User

An Object

Table of Contents
Note

Drop in one of our language drivers to accelerate your development.
Here are links to some of our popular Cookbooks to help you get started!

Parent

This Domain User is contained within a Domain.

Properties

The following properties are available:

Property Type Default Read-Only Description
_doc string No The primary ID
_system object No Metadata maintained by the system
authorities array No
directoryId string No The ID of the directory of the identity that holds this user's authentication credentials. The authentication credentials are not stored on the domain user object itself.
email string No The primary email address for the principal.
identityId string No The ID of the identity that holds this user's authentication credentials. The authentication credentials are not stored on the domain user object itself.
invitedDomainId string No If this user was invited from another domain, then this points back to the original user.
invitedPrincipalId string No If this user was invited from another domain, then this points back to the original user.
name string No
type string No

Schema


{
  "type": "object",
  "extends": "principal",
  "description": "Domain User",
  "container": "domain",
  "properties": {
    "email": {
      "type": "string",
      "description": "The primary email address for the principal."
    },
    "directoryId": {
      "type": "string",
      "description": "The ID of the directory of the identity that holds this user's authentication credentials. The authentication credentials are not stored on the domain user object itself."
    },
    "identityId": {
      "type": "string",
      "description": "The ID of the identity that holds this user's authentication credentials. The authentication credentials are not stored on the domain user object itself."
    },
    "invitedDomainId": {
      "type": "string",
      "description": "If this user was invited from another domain, then this points back to the original user."
    },
    "invitedPrincipalId": {
      "type": "string",
      "description": "If this user was invited from another domain, then this points back to the original user."
    },
    "name": null,
    "type": null,
    "authorities": null,
    "_doc": null,
    "_system": null
  },
  "id": "user"
}