SIsigmacomputing
Members

Create a member

Create a user.

Usage notes

  • Creating a user with this endpoint sends an email invitation to the user. Embed users are not sent email invitations.
  • Review the account types returned by the /v2/members endpoint to understand the format of the memberType string.
  • If memberType is omitted, the organization's Invitation default account type (configured in Admin > Account types) is used. If no Invitation default is configured, a built-in default account type is used.
  • Retrieve the teamId(s) by calling the /v2/teams endpoints.
post/v2/members

Request

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

Query parameters

sendInviteboolean

Whether to send an email invitation for non-embed users. If not included, an email is sent

Request body

emailstring email required
firstNamestring required
lastNamestring 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)

memberTypestring

Account type

isGuestboolean
userKind'internal' | 'guest' | 'embed'

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.