Wiki
Clone wikiNumera.LibrisAPI / identity.create
Home > API Reference Documentation > identity.create
identity.create
The identity.create action is used to create a new user identity. The way that a user will login is not known at the time you are creating an account, so this process reserves an email address, realm, and role for the user when they do register. This allows administrators in your application to create new accounts and then let their users register in your application and when those users authenticate for the first time their credentials and their identity will be linked using the email address. This will only work for users with the role of Agent Supervisor or above.
Input Parameters
| Property | Required | Description |
|---|---|---|
role | yes | A role for the user |
realm | yes | A realm for the user |
email | yes | The user's email (the user must register using this same email) |
secret | no | If you want to update the user's secret (only SUPERUSERs can do this) |
Output
If everything worked successfully, the result object will represent an identity object (the profile information will not be filled in since the user has not actually registered yet)... identity properties can be found here.
Possible Status Codes
| Status Code | Reason | Description |
|---|---|---|
1000 | NOT_IN_REALM | If the current user is not a Superuser, and their realm does not match the realm of the user they are trying to update, then the request will fail. |
1003 | INVALID_USER | The user was created but could not be loaded for response, this is an unexpected error |
1004 | ROLE_OUT_OF_BOUNDS | You tried to give a user a role you don't have the privilege to grant |
1006 | DUPLICATE_EMAIL | The email you are trying to create already exists for another user |
1007 | SECRET_UPDATE_RESTRICTED | User does not have permissions to update the secret |
Updated