Skip to main content
Version: 4.0.2

Create a new user

POST 
/users-srv/user/create/byadmin

Creates a new user account with admin-set password. The user account is immediately active and searchable.

Required Roles: admin, secondary_admin, or user_create

Key Features:

  • User account is created immediately (unlike invitations)
  • Admin sets the initial password
  • User receives a notification when notify_user is true (email or SMS per primaryType)
  • {{login_link}} in USER_CREATED uses initiate_login_uri from the request when provided, otherwise a built /authz-srv/authz URL
  • User can change password after first login

Important

When notify_user=true, cidaas generates a login link for the new user. In this scenario, additional OAuth parameters such as client_id and response_type are required for successful notification delivery.

Parameter dependency​

notify_userclient_idresponse_type
falseOptionalOptional
trueRequiredRequired

Conditional Required Fields​

  • notify_user: false: Creates the user only. No notification email is sent. OAuth-related parameters are not required.

  • notify_user: true (default): Creates the user, generates a notification email, and generates a login link. OAuth context (client_id, response_type) is required.

  • client_id: Required when notify_user=true. Identifies the application and is used when constructing the login URL in the notification email. It is not part of creating the user record itself.

  • response_type: Required when notify_user=true. Used only while generating the login link (authorization request). Recommended value: code. It is not required for creating the user record itself.

Common validation failures​

ErrorCause
AUTH10002response_type missing (or OAuth context incomplete) while generating the notification login link when notify_user=true
HTTP 400Required OAuth information missing for notification delivery

initiate_login_uri: Recommended — configure on the app in app settings when notify_user is true. Details: Create User.

Request​

Responses​

OK