Creates a new user object.
Parameter URL
Parameter | Type | Required | Default value | Description |
|---|---|---|---|---|
send_email | Boolean | No | false | If send_email is true, an email invitation will be sent to the user. |
Returns
Returns a new user object if the call succeeded. If a Slemma account exists with the email address specified in the call, this call will simply add this user to a new team with the new Groupkey, Role and Type. The user can belong to any number of teams, but can be the owner of one team only.
The following are the examples of HTTP status codes including errors that API can generate
Response codes | Response сontent | Description |
|---|---|---|
200 OK | The user object | The user has been created successfully. |
400 Bad Request | Email cannot be empty | The field "Email" cannot be empty. |
400 Bad Request | Invalid email address | The email address that was specified is invalid. |
400 Bad Request | Invalid User Type:"IncorrectType" | The 'Type' parameter that was specified is invalid. |
400 Bad Request | Invalid user role:"IncorrectRole" | The 'Role' parameter that was specified is invalid. |
400 Bad Request | 'Clients' feature is inactive. | You need the 'Clients' feature to be enabled for your account to create a new client. |
400 Bad Request | CanCreate is not available for admins | 'CanCreate' parameter is not allowed for users with 'Admin' role. Admins have full access by default. |
400 Bad Request | Incorrect user Type | The 'Type' parameter that was specified doesn't match the corresponding group UserType . |
400 Bad Request | Attribute not found, Key=112 | A team attribute wasn't found. |