Project

General

Profile

Actions

Webservices » History » Revision 1

Revision 1/5 | Next »
Sachin Divekar, 02/11/2023 05:06 PM


Webservices

user_create

Creates a new user.

Request

Endpoint

POST /users

URL Parameters:

  • realmName (string): Name of the realm for new user creation.
{
  "username": "rahuld",
  "email": "rahul@example.com",
  "firstName": "Rahul",
  "lastName": "Deshpande",
  "enabled": true
}
  • username: string, required. Username for the user.
  • email: string, required. User's email address.
  • firstName: string, optional. User's first name.
  • lastName: string, optional. User's last name.
  • enabled: boolean, required. Indicates if user account is enabled.

Response

{
  "id": "df84nsd....",
  "username": "rahuld",
  "email": "rahul@example.com",
  "firstName": "Rahul",
  "lastName": "Deshpande",
  "enabled": true
}
  • id: string, required. Unique user ID.
  • username: string, required. Username for the user.
  • email: string, optional. User's email address.
  • firstName: string, optional. User's first name.
  • lastName: string, optional. User's last name.
  • enabled: boolean, required. Indicates if user account is enabled.

Potential Error Codes

  • REALM_NOT_FOUND: Specified realm does not exist.
  • USERNAME_EXISTS: User with provided username already exists in the realm.

Updated by Sachin Divekar over 1 year ago · 1 revisions