POST /api/v1/users — untitled-api

UserService

CreateUser creates a new user.

post/api/v1/users

Query parameters

userIdstring

Optional. The user ID to use for this user. If empty, a unique ID will be generated. Must match the pattern [a-z0-9-]+

validateOnlyboolean

Optional. If set, validate the request but don't actually create the user.

requestIdstring

Optional. An idempotency token that can be used to ensure that multiple requests to create a user have the same result.

Request body

namestring

The resource name of the user. Format: users/{user}

role'ROLE_UNSPECIFIED' | 'HOST' | 'ADMIN' | 'USER' enum required

The role of the user.

usernamestring required

Required. The unique username for login.

emailstring

Optional. The email address of the user.

displayNamestring

Optional. The display name of the user.

avatarUrlstring

Optional. The avatar URL of the user.

descriptionstring

Optional. The description of the user.

passwordstring

Input only. The password for the user.

state'STATE_UNSPECIFIED' | 'NORMAL' | 'ARCHIVED' enum required

The state of the user.

createTimestring date-time

Output only. The creation timestamp.

updateTimestring date-time

Output only. The last update timestamp.

Response