Identity Provider API, gRPC: UserService.Create
Creates a user in the specified userpool.
gRPC request
rpc Create (CreateUserRequest) returns (operation.Operation)
CreateUserRequest
{
"userpool_id": "string",
"username": "string",
"full_name": "string",
"given_name": "string",
"family_name": "string",
"email": "string",
"phone_number": "string",
// Includes only one of the fields `password_spec`, `password_hash`
"password_spec": {
"password": "string",
"generation_proof": "string"
},
"password_hash": {
"password_hash": "string",
"password_hash_type": "PasswordHashType"
},
// end of the list of possible fields
"is_active": "google.protobuf.BoolValue",
"external_id": "string",
"company_name": "string",
"department": "string",
"job_title": "string",
"employee_id": "string"
}
Request to create a new user.
|
Field |
Description |
|
userpool_id |
string Required field. ID of the userpool to create the user in. The maximum string length in characters is 50. |
|
username |
string Required field. Username for the new user. The maximum string length in characters is 254. Value must match the regular expression |
|
full_name |
string Required field. Full name of the user. The maximum string length in characters is 256. |
|
given_name |
string First name of the user. The maximum string length in characters is 256. |
|
family_name |
string Last name of the user. The maximum string length in characters is 256. |
|
|
string Email address of the user. The maximum string length in characters is 254. Value must match the regular expression |
|
phone_number |
string Phone number of the user. The maximum string length in characters is 50. |
|
password_spec |
Password specification. Credentials type. Exactly one of credentials type must be specified. Includes only one of the fields User credentials. |
|
password_hash |
Password hash. Credentials type. Exactly one of credentials type must be specified. Includes only one of the fields User credentials. |
|
is_active |
Whether the user is active. Default is true. |
|
external_id |
string External identifier for the user. The maximum string length in characters is 256. |
|
company_name |
string User's company name. The maximum string length in characters is 256. |
|
department |
string User's department. The maximum string length in characters is 256. |
|
job_title |
string User's job title. The maximum string length in characters is 256. |
|
employee_id |
string User's employee ID The maximum string length in characters is 256. |
PasswordSpec
Password specification.
|
Field |
Description |
|
password |
string Required field. The password string. The maximum string length in characters is 128. |
|
generation_proof |
string Proof that the password was generated by the system. The maximum string length in characters is 128. |
PasswordHash
Password hash information.
|
Field |
Description |
|
password_hash |
string Required field. The password hash string. The maximum string length in characters is 128. |
|
password_hash_type |
enum PasswordHashType Required field. Type of the password hash.
|
operation.Operation
{
"id": "string",
"description": "string",
"created_at": "google.protobuf.Timestamp",
"created_by": "string",
"modified_at": "google.protobuf.Timestamp",
"done": "bool",
"metadata": "google.protobuf.Any",
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": "google.protobuf.Any"
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
|
Field |
Description |
|
id |
string ID of the operation. |
|
description |
string Description of the operation. 0-256 characters long. |
|
created_at |
Creation timestamp. |
|
created_by |
string ID of the user or service account who initiated the operation. |
|
modified_at |
The time when the Operation resource was last modified. |
|
done |
bool If the value is |
|
metadata |
Service-specific metadata associated with the operation. |
|
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
|
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |