HTTP Method & URL
POST <base-url>?Type=User&Version=1
<query parameters>
<query parameters>
Parameters
| Type | <Required> User |
| Version | <Required> API version# |
| UserId | <Required> This is the login-id (email address in local auth mode, or userid in LDAP mode) |
| EmailId | <Required> Email address of the user |
| FirstName | <Required> First name of the user |
| LastName | <Required> Last name of the user |
| Password | <Optional> Plain text password. Default is "connectbeam" |
Description
Creates a new user. For security, we don't allow creation of Admin users through the API. In LDAP Authentication mode, the password is ignored and the user is always authentication using the LDAP.
Returns
HTTP Status Code: 201 (successfully created) or 400 (bad request)
Example Response
For a successful transaction, there is no XML response. For failed requests, the response is the standard XML error response as described in the API Summary section.
Notes:
- The Login API does not automatically create a "personal" (private) group for the user. To create a "personal" group for the user, use the Create Group API. Each user of the Connectbeam application should have a "personal"group.