We've reorganized our documentation navigation structure to align directly with your operational workflows. See the release notes and the walkthrough video for more information.

User

JSON representation
TimeOff
- JSON representation

Information about a user.

JSON representation

JSON representation
{ "productObjectId": string, "userid": string, "userDisplayName": string, "firstName": string, "middleName": string, "lastName": string, "phoneNumbers": [ string ], "personalAddress": { object (`Location`) }, "attribute": { object (`Attribute`) }, "firstSeenTime": string, "accountType": enum (`AccountType`), "groupid": string, "groupIdentifiers": [ string ], "windowsSid": string, "emailAddresses": [ string ], "employeeId": string, "title": string, "companyName": string, "department": [ string ], "officeAddress": { object (`Location`) }, "managers": [ { object (`User`) } ], "hireDate": string, "terminationDate": string, "timeOff": [ { object (`TimeOff`) } ], "lastLoginTime": string, "lastPasswordChangeTime": string, "passwordExpirationTime": string, "accountExpirationTime": string, "accountLockoutTime": string, "lastBadPasswordAttemptTime": string, "userAuthenticationStatus": enum (`AuthenticationStatus`), "roleName": string, "roleDescription": string, "userRole": enum (`Role`) }

{
  "productObjectId": string,
  "userid": string,
  "userDisplayName": string,
  "firstName": string,
  "middleName": string,
  "lastName": string,
  "phoneNumbers": [
    string
  ],
  "personalAddress": {
    object (Location)
  },
  "attribute": {
    object (Attribute)
  },
  "firstSeenTime": string,
  "accountType": enum (AccountType),
  "groupid": string,
  "groupIdentifiers": [
    string
  ],
  "windowsSid": string,
  "emailAddresses": [
    string
  ],
  "employeeId": string,
  "title": string,
  "companyName": string,
  "department": [
    string
  ],
  "officeAddress": {
    object (Location)
  },
  "managers": [
    {
      object (User)
    }
  ],
  "hireDate": string,
  "terminationDate": string,
  "timeOff": [
    {
      object (TimeOff)
    }
  ],
  "lastLoginTime": string,
  "lastPasswordChangeTime": string,
  "passwordExpirationTime": string,
  "accountExpirationTime": string,
  "accountLockoutTime": string,
  "lastBadPasswordAttemptTime": string,
  "userAuthenticationStatus": enum (AuthenticationStatus),
  "roleName": string,
  "roleDescription": string,
  "userRole": enum (Role)
}

Fields
`productObjectId`	`string` A vendor-specific identifier to uniquely identify the entity (e.g. a GUID, LDAP, OID, or similar). This field can be used as an entity indicator for user entities.
`userid`	`string` The ID of the user. This field can be used as an entity indicator for user entities.
`userDisplayName`	`string` The display name of the user (e.g. "John Locke").
`firstName`	`string` First name of the user (e.g. "John").
`middleName`	`string` Middle name of the user.
`lastName`	`string` Last name of the user (e.g. "Locke").
`phoneNumbers[]`	`string` Phone numbers for the user.
`personalAddress`	`object (Location)` Personal address of the user.
`attribute`	`object (Attribute)` Generic entity metadata attributes of the user.
`firstSeenTime`	`string (Timestamp format)` The first observed time for a user. The value is calculated on the basis of the first time the identifier was observed. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`.
`accountType`	`enum (AccountType)` Type of user account (for example, service, domain, or cloud). This is somewhat aligned to: https://attack.mitre.org/techniques/T1078/
`groupid (deprecated)`	`string` This item is deprecated! The ID of the group that the user belongs to. Deprecated in favor of the repeated groupIdentifiers field.
`groupIdentifiers[]`	`string` Product object identifiers of the group(s) the user belongs to A vendor-specific identifier to uniquely identify the group(s) the user belongs to (a GUID, LDAP OID, or similar).
`windowsSid`	`string` The Microsoft Windows SID of the user. This field can be used as an entity indicator for user entities.
`emailAddresses[]`	`string` Email addresses of the user. This field can be used as an entity indicator for user entities.
`employeeId`	`string` Human capital management identifier. This field can be used as an entity indicator for user entities.
`title`	`string` User job title.
`companyName`	`string` User job company name.
`department[]`	`string` User job department
`officeAddress`	`object (Location)` User job office location.
`managers[]`	`object (User)` User job manager(s).
`hireDate`	`string (Timestamp format)` User job employment hire date. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`.
`terminationDate`	`string (Timestamp format)` User job employment termination date. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`.
`timeOff[]`	`object (TimeOff)` User time off leaves from active work.
`lastLoginTime`	`string (Timestamp format)` User last login timestamp. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`.
`lastPasswordChangeTime`	`string (Timestamp format)` User last password change timestamp. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`.
`passwordExpirationTime`	`string (Timestamp format)` User password expiration timestamp. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`.
`accountExpirationTime`	`string (Timestamp format)` User account expiration timestamp. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`.
`accountLockoutTime`	`string (Timestamp format)` User account lockout timestamp. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`.
`lastBadPasswordAttemptTime`	`string (Timestamp format)` User last bad password attempt timestamp. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`.
`userAuthenticationStatus`	`enum (AuthenticationStatus)` System authentication status for user.
`roleName (deprecated)`	`string` This item is deprecated! System role name for user. Deprecated: use attribute.roles.
`roleDescription (deprecated)`	`string` This item is deprecated! System role description for user. Deprecated: use attribute.roles.
`userRole (deprecated)`	`enum (Role)` This item is deprecated! System role for user. Deprecated: use attribute.roles.

TimeOff

System record for leave/time-off from a Human Capital Management (HCM) system.

JSON representation
{ "interval": { object (`Interval`) }, "description": string }

Fields

Fields
`interval`	`object (Interval)` Interval duration of the leave.
`description`	`string` Description of the leave if available (e.g. 'Vacation').

interval

object (Interval)

Interval duration of the leave.

description

string

Description of the leave if available (e.g. 'Vacation').

User Stay organized with collections Save and categorize content based on your preferences.

TimeOff

User