Table of Contents

User

UserId : int64Code : stringFullName : stringPrimaryEmail : stringNotes : stringPermissionChanged : booleanIsActive : booleanIsAdministrator : booleanCreatedOn : datetimeModifiedOn : datetimeVersion : int32ContentTranslate : booleanPermissionTreeSiteResourceLanguageDateFormatDateSeparatorTimeFormatuser rightscreated bymodified bysiteassociated staff memberdefault languagesystem date formatsystem date separatorsystem time format

Learn more about Users from the following resources:

Operations

Operation Operation Id Summary Detail
GET GetUser

Get a User resource.

View

PATCH UpdateUser

Update an existing User resource.

View

DELETE DeleteUser

Delete an existing User resource.

View

GET GetUserCollection

Get a collection of User resources.

View

POST CreateUser

Create a new User resource.

View

GET GetUserSiteApprovalRoleForUserCollection

Get a collection of User Site Approval Role resources for the User.

View

GET LookupAssociatedStaffMember

Lookup the Resource for the User.

View

GET LookupAssociatedSupplier

Lookup the Supplier for the User.

View

GET LookupDefaultLanguage

Lookup the Language for the User.

View

GET LookupSite

Lookup the Site for the User.

View

GET LookupUserChangePermissionTree

Lookup the permission set for changing the User.

View

GET LookupUserInsertPermissionTree

Lookup the permission set for creating the User.

View

GET BatchGetUser

Get a collection of User resources for the set of id's.

View

POST BatchCreateUser

Create a new collection of User resources.

View

PATCH BatchUpdateUser

Update a collection of existing User resources.

View

DELETE BatchDeleteUser

Delete a collection of existing User resources.

View

POST BatchCalculateUserPermissions

Batch Calculate User Permissions

View

PATCH BatchChangeIsAdministrator

Batch Change Is Administrator Flag

View

POST BatchCreateUserInviteToken

Batch Invite Users

View

POST CalculateUserPermissions

Calculate User Permissions

View

POST ChangeUserAuthenticationStatus

Change User Authentication Status

View

PATCH ChangeUserIsActive

Change the IsActive status for an existing User resource.

View

PATCH ChangeIsAdministrator

Change Is Administrator Flag

View

PATCH ChangeUserPermissionTree

Change the PermissionTree for an existing User resource.

View

PATCH ChangeUserSite

Change the Site status for an existing User resource.

View

POST CreateUserInviteToken

Create and send an e-mail invitation to activate the User

View

POST LinkUserIdentity

Link the invited User to On Key

View

PATCH BatchChangeUserIsActive

Change the IsActive status for a collection of existing User resources.

View

PATCH BatchChangeUserPermissionTree

Change the PermissionTree status for a collection of existing User resources.

View

PATCH BatchChangeUserSite

Change the Site status for a collection of existing User resources.

View

PATCH MatchUpdateUser

Update a collection of existing User resources to have the same value(s).

View