Discuss with expertTry it for free
© 2026 Direct Cursus Technology L.L.C.

Identity Provider API, gRPC: UserService.Create

Written by
Updated at May 27, 2026

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 [a-z0-9A-Z\._-]{1,64}@.{1,256}.

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.

email

string

Email address of the user.

The maximum string length in characters is 254. Value must match the regular expression |(.{3,254}).

phone_number

string

Phone number of the user.

The maximum string length in characters is 50.

password_spec

PasswordSpec

Password specification. Credentials type. Exactly one of credentials type must be specified.

Includes only one of the fields password_spec, password_hash.

User credentials.

password_hash

PasswordHash

Password hash. Credentials type. Exactly one of credentials type must be specified.

Includes only one of the fields password_spec, password_hash.

User credentials.

is_active

google.protobuf.BoolValue

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.

  • AD_MD4: Microsoft Active Directory MD4 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

google.protobuf.Timestamp

Creation timestamp.

created_by

string

ID of the user or service account who initiated the operation.

modified_at

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

google.protobuf.Any

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

google.protobuf.Any

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.
Previous
List
Next
Update