Create a member

POST

/v2/members

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.

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](https://help.sigmacomputing.com/reference/list-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](https://help.sigmacomputing.com/reference/list-teams) endpoints.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

sendInvitebooleanOptional

Request

The request body.

emailstringRequiredformat: "email"

firstNamestringRequired

lastNamestringRequired

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

isArchivedboolean

Whether a user is deactivated in Sigma.

isInactiveboolean

Whether a user is archived by SCIM.

$	curl -X POST https://api.sigmacomputing.com/v2/members \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"email": "jane.doe@example.com",
>	"firstName": "Jane",
>	"lastName": "Doe"
>	}'

1	{
2	"organizationId": "org-1234567890abcdef",
3	"memberId": "mem-0987654321fedcba",
4	"memberType": "standard_user",
5	"firstName": "Jane",
6	"lastName": "Doe",
7	"email": "jane.doe@example.com",
8	"profileImgUrl": "https://cdn.sigmacomputing.com/profiles/jane_doe.png",
9	"createdBy": "admin-001",
10	"updatedBy": "admin-001",
11	"createdAt": "2024-01-15T09:30:00Z",
12	"updatedAt": "2024-01-15T09:30:00Z",
13	"homeFolderId": "folder-abc123def456",
14	"userKind": "internal",
15	"isArchived": false,
16	"isInactive": false
17	}