CreateUserResponse

CreateUserResponse is a data structure used by services and APIs to convey the outcome of a CreateUser operation. It typically represents the server's response after a request to create a new user is processed. The object often includes information about the newly created user, along with status information and optional metadata about the operation.

Common fields include: success or status (boolean or enum), id or userId (the unique identifier of the created user), createdAt timestamp, username or displayName (optional), and a location or resourceUrl indicating where the new user resource can be accessed. Some implementations return a user object with core attributes, while others return a minimal set. Additional fields may include correlationId for tracing, etag or version, and any validation or error details if creation failed.

Behavior: on success, the response indicates success and provides identifiers and URLs; on failure, it carries error details such as errorCode, message, and potentially a list of validation issues. Idempotent create workflows may use an idempotencyKey to ensure a single resource is created for repeated requests.

Usage considerations: CreateUserResponse is typically serialized as JSON in RESTful APIs and consumed by clients to confirm the creation and to retrieve the new user’s location. It should be designed to be backward compatible and to avoid leaking sensitive information in error messages.

See also: CreateUserRequest, User, UpdateUserResponse, ListUsersResponse, API error models.