Skip to navigation
Sigma REST APIMembers

Create a member

View as Markdown

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.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

sendInvitebooleanOptional

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

Request

The request body.
emailstringRequiredformat: "email"
firstNamestringRequired
lastNamestringRequired
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)

memberTypestringOptional
Account type
isGuestbooleanOptional
userKindenumOptional
Allowed values:
addToTeamslist of objectsOptional
Add user to one or more teams.

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.