Create User
Creating a user
Use the createUser
mutation to create a new account for an end-user on your organization's account.
Anonymization: Kindly be aware that the essential fields for creating a user profile include the name and email. If you prefer a completely anonymous format, you are welcome to provide a generic user name, like "<ORGANIZATION_NAME> User," and a distinct email address, such as "<USER_ID>@<ORGANIZATION_DOMAIN>".
Arguments
Argument | Required | Type | Description |
| True | String | User's name |
| True | String | User's email |
| False | String | User's phone |
| False | String | Set up a user's password |
| False | String | Include the database ID of the Program. If this parameter is not sent, the program can be later assgined by using the |
| False | String | Restriction Base-64 ID. If this parameter is not sent, restrictions can be later assigned by using the |
| False | Boolean | Notification sent via email to set up a user's password |
| False | ID | Base-64 subscription ID which will be assigned to the created user. |
Available Fields
The following fields will be displayed in the response:
Field | Type | Description |
| string | True if the user has been created successfully. Otherwise, False |
| string | Description of the result |
| A structured version of user information. It contains |
Examples
GraphQL
Include the databaseId
information along with the token id in the HTTP HEADERS within the GraphQL playground:
Note: Use the databaseId
in the sg-user
header to start using mutations and queries
cURL Example
Python Example
PHP Example
Setup a user's password
The following example creates a user and sets up the password without sending an email notification.
Send an email to set up a password
The following example creates a user and sends a password notification to the user's email to set up a password.
The following notification will arrive in the user's email:
Click on this link to set up the password, users are redirected to the following page where a new password must be introduced:
Assign a subscription to the user
The following message is displayed in case the subscription does not exist:
Last updated