Skip to navigation
Sigma REST APIMembers{memberId}

Update member

View as Markdown

Update a specific user by memberId.

Usage notes

  • Retrieve the memberId by calling the /v2/members endpoint.
  • Review the account types returned by the same endpoint to understand the format of the memberType string.
  • To deactivate a user and reassign their documents to a specific user, set newOwnerIdto the user ID of the desired document owner, and isArchived to True. For more details, see Deactivate a user.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

memberIdstringRequired

Request

The request body.
memberTypestringOptional
Account type
firstNamestringOptional
lastNamestringOptional
profileImgUrlstring or nullOptional
emailstringOptional
languageenumOptional

The user’s preferred display language. Pass null to revert to the organization default. (Beta)

formatRegionenumOptional

Controls number, date, and currency formatting for the user, following the conventions of the specified region. Pass null to revert to the organization default. (Beta)

isArchivedbooleanOptional
Whether to deactivate a user in Sigma.
isInactivebooleanOptional
Whether to archive a user with SCIM.
userKindenumOptional
Allowed values:
newOwnerIdstringOptional
archiveDocumentsbooleanOptional

Archive a user’s documents instead of transferring them. Can only be used if either isArchived or isInactive is set to true. Also archives scheduled exports.

archiveScheduledExportsbooleanOptional

Archive a user’s scheduled exports instead of transferring them. Can only be used if either isArchived or isInactive is set to true

Response

The response body.
organizationIdstring
memberIdstring
memberTypestring
firstNamestring
lastNamestring
emailstring
profileImgUrlstring or null
createdBystring
updatedBystring
createdAtdatetime
updatedAtdatetime
homeFolderIdstring
ID of the My Documents folder for the user
userKindstring
languageenumOptional

The user’s preferred display language. (Beta)

formatRegionenumOptional

Controls number, date, and currency formatting for the user, following the conventions of the specified region. (Beta)

isArchivedbooleanOptional
Whether a user is deactivated in Sigma.
isInactivebooleanOptional
Whether a user is archived by SCIM.