SIsigmacomputing
Members

Update member

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.
patch/v2/members/{memberId}

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Path parameters

memberIdstring required

Request body

memberTypestring

Account type

firstNamestring
lastNamestring
profileImgUrlstring nullable
emailstring
language'DE_DE' | 'EN' | 'EN_AU' | 'EN_CA' | 'EN_GB' | 'EN_IE' | 'ES_ES' | 'ES_MX' | 'FR_CA' | 'FR_FR' | 'IT_IT' | 'JA_JA' | 'KO_KR' | 'NL_NL' | 'PL_PL' | 'PT_BR' | 'PT_PT' | 'RU_RU' | 'SV_SE' | 'TH_TH' | 'TR_TR' | 'ZH_CN' | 'ZH_TW'

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

formatRegion'AU' | 'BR' | 'CA' | 'CN' | 'DE' | 'ES' | 'FR' | 'GB' | 'IE' | 'IT' | 'JP' | 'KR' | 'MX' | 'NL' | 'PL' | 'PT' | 'RU' | 'SE' | 'TH' | 'TR' | 'TW' | 'US'

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)

isArchivedboolean

Whether to deactivate a user in Sigma.

isInactiveboolean

Whether to archive a user with SCIM.

userKind'internal' | 'guest' | 'embed'
newOwnerIdstring
archiveDocumentsboolean

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.

archiveScheduledExportsboolean

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 required
memberIdstring required
memberTypestring required
firstNamestring required
lastNamestring required
emailstring required
profileImgUrlstring nullable required
createdBystring required
updatedBystring required
createdAtstring date-time required
updatedAtstring date-time required
homeFolderIdstring required

ID of the My Documents folder for the user

userKindstring required
language'DE_DE' | 'EN' | 'EN_AU' | 'EN_CA' | 'EN_GB' | 'EN_IE' | 'ES_ES' | 'ES_MX' | 'FR_CA' | 'FR_FR' | 'IT_IT' | 'JA_JA' | 'KO_KR' | 'NL_NL' | 'PL_PL' | 'PT_BR' | 'PT_PT' | 'RU_RU' | 'SV_SE' | 'TH_TH' | 'TR_TR' | 'ZH_CN' | 'ZH_TW'

The user's preferred display language. (Beta)

formatRegion'AU' | 'BR' | 'CA' | 'CN' | 'DE' | 'ES' | 'FR' | 'GB' | 'IE' | 'IT' | 'JP' | 'KR' | 'MX' | 'NL' | 'PL' | 'PT' | 'RU' | 'SE' | 'TH' | 'TR' | 'TW' | 'US'

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

isArchivedboolean

Whether a user is deactivated in Sigma.

isInactiveboolean

Whether a user is archived by SCIM.

Changes

No recorded changes to this operation across all 1 revision of this API.