Organization Member API

The following article covers Sigma’s developer API for organization members. 

Summary of Content

Endpoints
The Member Object
      Attributes
The Invited Member Object
      Attributes
List all Organization Members
      Permissions 
      Parameters
      cURL Request
      Response
      Example
Look up an Organization Member
      Permissions 
      Parameters
      cURL Request
      Response
      Example
Invite a New Member to Your Organization
      Permissions
      Parameters
      cURL Request
      Response
      Example
Update a Member in Your Organization
      Permissions 
      Parameters
      cURL Request
      Response
      Example
Deactivate an Organization Member
      Permissions 
      Parameters
      cURL Request
      Response
      Example
Related Resources

Endpoints

GET /v2/members

      Returns a list of members in your organization. Learn more
      Try it in Swagger

GET /v2/members/{memberId}

      Returns a member object based on its unique identifier, memberId. Learn more
      Try it in Swagger

POST /v2/members

      Sends an invite to your soon-to-be new organization member. Returns an invited member object containing a unique identifier (memberId) associated with the new user.  Learn more
      Try it in Swagger

Only one invite can be sent per request.

PATCH /v2/members/{memberId}

      Updates a user's attributes based on its unique identifier, memberId, and the request body. Returns the associated member object.
      Learn more
      Try it in Swagger

DELETE /v2/members/{memberId}

      Deactivates a user based on its unique identifier, memberId. Returns an empty object. Learn more
      Try it in Swagger

       Deactivated users can be reactivated at any time from within the Admin Portal, or by using the PATCH endpoint to update the user's isArchived attribute to be false. 


The Member Object

Attributes

organizationId string

The organization’s unique identifier.

memberId string

The member’s unique identifier.

memberType string

“admin” | “author” | “creator” | “explorer” | “viewer” | <custom-account-type>
Learn more about account types

firstName string

The first name listed on the member’s account.

lastName string

The last name listed on the member’s account.

email string

The email address associated with the member’s account.

profileImgUrl string | null

A URL path to the member’s saved profile image. This value remains Null if the user does not have a custom profile image.

createdBy string

The unique identifier, memberId, of the member who created the account either through invite or signup.

updatedBy string

The unique identifier, memberId, of the member who last made changes to the account.

createdAt string

The timestamp at which the account was created.

updatedAt string

The timestamp at which the account was last updated.

isArchived boolean | undefined

true if the member's user account is deactivated, false if the member's user account is active.

 {
    "organizationId": "cf2de26e-9a2c-4c58-ba1c-91a0955df7ez",
    "memberId": "7xtVWXPJqLptLezceRadESnwfttOP",
    "memberType": "creator",
    "firstName": "Anna",
    "lastName": "Jacobs",
    "email": "anna_jacobbs@myawesomecompany.com",
    "profileImgUrl": "https://img-c2.sigmacomputing.com/cf2de26e-9a2c-4c58-ba1c-91a0955df7ee/7a8709c2-37dd-4171-a9a5-a9e33gt0da55",
    "createdBy": "6VZszXPJqLXpIezceRadESnwfPPUg",
    "updatedBy": "6VZszXPJqLXpIezceRadESnwfPPUg",
    "createdAt": "2021-10-04T20:36:41.044Z",
    "updatedAt": "2021-10-08T21:38:25.044Z"
  }

 

The Invited Member Object

Attributes

memberId string

The organization member's unique identifier.

{
   "memberId": "7xtVWXPJqLptLezceRadESnwfttOP"
}

 

List all Organization Members

Returns a list of members in your organization.

Note: By default doesn't include pending invites nor deactivated/archived members.

GET /v2/members

Try it in Swagger

Permissions 

  • The user account associated with the API access token must have access to view organization members. Only Admins have this level of access.

    If you encounter a permission error for the given endpoint, check with your organization Admin to verify your account type and permissions associated with your API token.

Parameters

includeArchived boolean [optional]

When set to 'true', the returned list of members in your organization will include deactivated/archived members.

CURL Request

curl --location --request GET 'https://api.sigmacomputing.com/v2/members?includeArchived={boolean}' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \

 

Response

Returns Array<Member>.

Array<{
    "organizationId": string
    "memberId": string
    "memberType": "admin" | "creator" | "explorer" | "viewer" | string,
    "firstName": string
    "lastName": string
    "email": string
    "profileImgUrl": string | null,
    "createdBy": string
    "updatedBy": string
    "createdAt": string
    "updatedAt": string
    "isArchived": boolean
}>

 

Example

Example Request:

curl --location --request GET 'https://api.sigmacomputing.com/v2/members' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \

 

Example Response:

[
 {
    "organizationId": "cf2de26e-9a2c-4c58-ba1c-91a0955df7ez",
    "memberId": "6VZszXPJqLXpIezceRadESnwfPPUg",
    "memberType": "admin",
    "firstName": "Paul",
    "lastName": "Sudds",
    "email": "paul_sudds@myawesomecompany.com",
    "profileImgUrl": "https://img-c2.sigmacomputing.com/rtE6e26e-9a2c-4c58-ba1c-91a0955df7ee/787g6409c2-37dd-4171-a9a5-a9e33gt89ry5o",
    "createdBy": "6VZszXPJqLXpIezceRadESnwfPPUg",
    "updatedBy": "6VZszXPJqLXpIezceRadESnwfPPUg",
    "createdAt": "2021-08-07T11:26:41.044Z",
    "updatedAt": "2021-09-23T21:38:25.044Z"
  },
  {
    "organizationId": "cf2de26e-9a2c-4c58-ba1c-91a0955df7ez",
    "memberId": "7xtVWXPJqLptLezceRadESnwfttOP",
    "memberType": "creator",
    "firstName": "Anna",
    "lastName": "Jacobs",
    "email": "anna_jacobs@myawesomecompany.com",
    "profileImgUrl": "https://img-c2.sigmacomputing.com/cf2de26e-9a2c-4c58-ba1c-91a0955df7ee/7a8709c2-37dd-4171-a9a5-a9e33gt0da55",
    "createdBy": "6VZszXPJqLXpIezceRadESnwfPPUg",
    "updatedBy": "6VZszXPJqLXpIezceRadESnwfPPUg",
    "createdAt": "2021-10-04T20:36:41.044Z",
    "updatedAt": "2021-10-08T21:38:25.044Z"
   },
   ...
]

 

Look up an Organization Member

Returns a member object based on its unique identifier, memberId.

GET /v2/members/{memberId}

Try it in Swagger

 

Permissions 

  • The user account associated with the API access token must have permission to view organization members. Only Admins have this level of permission.

    If you encounter a permission error for the endpoint, check with your organization Admin to verify your account type and permissions associated with your API token.

Parameters

None

cURL Request

curl --location --request GET 'https://api.sigmacomputing.com/v2/members/{memberId} \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \

 

Response

Returns a member object.

{
    "organizationId": string
    "memberId": string
    "memberType": "admin" | "creator" | "explorer" | "viewer" | string,
    "firstName": string
    "lastName": string
    "email": string
    "profileImgUrl": string | null,
    "createdBy": string
    "updatedBy": string
    "createdAt": string,
    "updatedAt": string,
    "isArchived": boolean | undefined
}

 

Example

Example Request:

curl --location --request GET 'https://api.sigmacomputing.com/v2/members/cf2de26e-9a2c-4c58-ba1c-91a0955df7ez \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \


Example Response:

{
    "organizationId": "cf2de26e-9a2c-4c58-ba1c-91a0955df7ez",
    "memberId": "7xtVWXPJqLptLezceRadESnwfttOP",
    "memberType": "creator",
    "firstName": "Anna",
    "lastName": "Jacobs",
    "email": "anna_jacobs@myawesomecompany.com",
    "profileImgUrl": "https://img-c2.sigmacomputing.com/cf2de26e-9a2c-4c58-ba1c-91a0955df7ee/7a8709c2-37dd-4171-a9a5-a9e33gt0da55",
    "createdBy": "6VZszXPJqLXpIezceRadESnwfPPUg",
    "updatedBy": "6VZszXPJqLXpIezceRadESnwfPPUg",
    "createdAt": "2021-10-04T20:36:41.044Z",
    "updatedAt": "2021-10-08T21:38:25.044Z",
    "isArchived": false
}

 

Invite a New Member to Your Organization

Sends an email invite to your soon-to-be new organization member. Returns an object containing a unique identifier (memberId) associated with the new user. 

Only one invite can be sent per request.

Admins can add invited users to teams and grant them permissions, before the invitee logs into Sigma for the first time.

POST /v2/members

Try it in Swagger

 

Permissions

  • The user account associated with the API access token must have permission to invite organization members. Only Admins have this level of permission.

    If you encounter a permission error for the given endpoint, check with your organization Admin to verify your account type and permissions associated with your API token.

Parameters

email string

The email address to associate with the new account. An invite will be sent to this address. 

firstName string

The new member's first name.
 

lastName string

The new member's last name.

memberType string

The account type to be assigned to the new member. 

isGuest boolean [optional]

If true, the new member will be assigned a guest user account. 
Defaults to false if left undefined.

 

cURL Request

curl --location --request POST 'https://api.sigmacomputing.com/v2/members/ \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": string,
    "firstName": string,
    "lastName": string,
    "memberType": string,
    "isGuest": boolean | undefined
}'

 

Response

Returns an invited member object.

{
    "memberId": string
}


Example

Example Request:

curl --location --request POST 'https://api.sigmacomputing.com/v2/members/ \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "anna_jacobs@myawesomecompany.com",
    "firstName": "Anna",
    "lastName": "Jacobs",
    "memberType": "explorer",
    "isGuest": true
}'


Example Response:

{
    "memberId": "7xtVWXPJqLptLezceRadESnwfttOP",
}

 

Update a Member in Your Organization

PATCH /v2/members/{memberId}

      Updates a user's attributes based on its unique identifier, memberId, and the request body. Returns the associated member object.
      Try it in Swagger

Permissions 

  • The user account associated with the API access token must have permission to update organization members metadata. Only Admins have this level of permission.

    If you encounter a permission error for the given endpoint, check with your organization Admin to verify your account type and permissions associated with your API token.

Parameters

firstName string

The member's new first name.

lastName string

The member's new last name.

memberType string

The account type to be assigned to the member. 

profileImgUrl string | null

A URL path to the member’s saved profile image. 

 

email string

The member's new email address.

isArchived boolean

Whether the member's user account should be active (false) or deactivated (true)

userKind string

Define the type of user. The three possible values are guest, internal, or embed. 

cURL Request

curl --location --request PATCH 'https://api.sigmacomputing.com/v2/members/{memberId} \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"firstName": string,
"lastName": string,
"memberType": string,
    "profileImgUrl": string,
    "email": string,
    "isArchived": boolean,
    "userKind": string
}'

 

Response

Returns a member object.

{
    "organizationId": string,
    "memberId": string,
    "memberType": "admin" | "creator" | "explorer" | "viewer" | string,
    "firstName": string,
    "lastName": string,
    "email": string,
    "profileImgUrl": string | null,
    "createdBy": string,
    "updatedBy": string,
    "createdAt": string,
    "updatedAt": string,
    "isArchived": boolean | undefined
}

 

Example

Example Request:

curl --location --request POST 'https://api.sigmacomputing.com/v2/members/7xtVWXPJqLptLezceRadESnwfttOP \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "firstName": "Anna",
    "lastName": "Jacobs",
    "memberType": "creator",
    "profileImgUrl": "https://img-c2.sigmacomputing.com/cf2de26e-9a2c-4c58-ba1c-91a0955df7ee/7a8709c2-37dd-4171-a9a5-a9e33gt0da55",
    "email": "anna_jocabs@myawesomecompany.com",
    "isArchived": false,
    "userKind"; "internal"
}'


Example Response:

{
    "organizationId": "cf2de26e-9a2c-4c58-ba1c-91a0955df7ez",
    "memberId": "7xtVWXPJqLptLezceRadESnwfttOP",
    "memberType": "creator",
    "firstName": "Anna",
    "lastName": "Jacobs",
    "email": "anna_jocabs@myawesomecompany.com",
    "profileImgUrl": "https://img-c2.sigmacomputing.com/cf2de26e-9a2c-4c58-ba1c-91a0955df7ee/7a8709c2-37dd-4171-a9a5-a9e33gt0da55",
    "createdBy": "6VZszXPJqLXpIezceRadESnwfPPUg",
    "updatedBy": "6VZszXPJqLXpIezceRadESnwfPPUg",
    "createdAt": "2021-10-04T20:36:41.044Z",
    "updatedAt": "2021-10-08T21:38:25.044Z",
    "isArchived": false
}

 

Deactivate an Organization Member

Deactivates a user based on its unique identifier, memberId. Returns an empty object.
Deactivated users can be reactivated at any time from within the Admin Portal, or by using the PATCH endpoint to update the user's isArchived attribute to be false. 

DELETE /v2/members/{memberId}

Try it in Swagger

Permissions 

  • The user account associated with the API access token must have permission to deactivate organization members. Only Admins have this level of permission.

    If you encounter a permission error for the given endpoint, check with your organization Admin to verify your account type and permissions associated with your API token.

Parameters

None

cURL Request

curl --location --request DELETE 'https://api.sigmacomputing.com/v2/member/{memberId}' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \

 

Response

{}

 

Example

Example Request:

curl --location --request POST 'https://api.sigmacomputing.com/v2/member/7xtVWXPJqLptLezceRadESnwfttOP' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \


Example Response:

{}

 

Related Resources

API Documentation

Get Started with Sigma's API
Create an API Token and Client Id
Identify Unique Ids in Sigma

Product Documentation

People & Teams

Was this page helpful?
Yes No