CreateUserRequest

CreateUserRequest is a data structure used in many applications to convey the information required to create a new user account. In API terms, it is the payload sent by a client to a user-management service when issuing a create operation. The exact schema varies by system, but it typically contains credentials, contact details, and optional profile information.

Common fields include username (required), password (required), email (required in most systems), displayName or fullName, phoneNumber, locale, timeZone, and an optional list of roles or groups. Some designs separate authentication credentials from profile data, in which case CreateUserRequest focuses on core identity attributes and the server assigns credentials at creation time.

Validation rules usually enforce unique usernames or emails, length constraints, allowed character sets, and password strength. Sensitive fields like passwords must be transmitted over TLS, stored only after proper hashing, and never logged or exposed in responses.

Usage: in a RESTful API, a POST request to endpoint such as /users with a body that matches CreateUserRequest. The server typically returns a success indicator, a new user identifier, and creation timestamp.

Example: { "username": "jdoe", "password": "S3cureP@ss", "email": "[email protected]", "displayName": "John Doe", "roles": ["USER"] }

See also: CreateUserResponse, User, API design patterns.