Users

Users

Users

Get

client.users.retrieve(stringid, RequestOptionsoptions?): expandedunionuserViewUserViewUserRetrieveResponse

get/api/v1/users/{id}

List

client.users.list(UserListParamsquery?, RequestOptionsoptions?): expandedunionlistunionnextPageTokenstringUserListResponse

get/api/v1/users

User View

UserView

The UserView object provides a user response object, as well as JSONPATHs to related objects provided by expanders.

ShowShow

delegatedUserPathstring

optional

JSONPATH expression indicating the location of the user objects of delegates of the current user in the expanded array.

directoriesPathstring

optional

JSONPATH expression indicating the location of directory objects in the expanded array.

managersPathstring

optional

JSONPATH expression indicating the location of the user objects that managed the current user in the expanded array.

rolesPathstring

optional

JSONPATH expression indicating the location of the roles of the current user in the expanded array.

useridstringcreatedAtstringdelegatedUserIdstringdeletedAtstringdepartmentstringdepartmentSourcesuniondirectoryIdsuniondirectoryStatusuniondirectoryStatusSourcesuniondisplayNamestringemailstringemailsunionemailSourcesunionemployeeIdsunionemployeeIdSourcesunionemploymentStatusstringemploymentStatusSourcesunionemploymentTypestringemploymentTypeSourcesunionjobTitlestringjobTitleSourcesunionmanagerIdsunionmanagerSourcesunionprofileRecord<string, unknown>roleIdsunionstatusuniontypeunionupdatedAtstringusernamestringusernamesunionusernameSourcesunionC1APIUserV1User

optional

The User object provides all of the details for an user, as well as some configuration.