Identity Provider API, gRPC: UserService.Get
Returns the specified user.
To get the list of available users, make a List request.
gRPC request
rpc Get (GetUserRequest) returns (User)
GetUserRequest
{
"user_id": "string"
}
Request to get a user by ID.
|
Field |
Description |
|
user_id |
string Required field. ID of the user to return. The maximum string length in characters is 50. |
User
{
"id": "string",
"userpool_id": "string",
"status": "Status",
"username": "string",
"full_name": "string",
"given_name": "string",
"family_name": "string",
"email": "string",
"phone_number": "string",
"created_at": "google.protobuf.Timestamp",
"updated_at": "google.protobuf.Timestamp",
"external_id": "string",
"company_name": "string",
"department": "string",
"job_title": "string",
"employee_id": "string"
}
A user in the Identity Provider system.
Users are created within a userpool and can authenticate to access cloud resources.
Each user has a unique identifier, credentials, and profile information.
|
Field |
Description |
|
id |
string Unique identifier of the user. |
|
userpool_id |
string ID of the userpool this user belongs to. |
|
status |
enum Status Current status of the user.
|
|
username |
string Username used for authentication. |
|
full_name |
string User's full name (display name). |
|
given_name |
string User's first name. |
|
family_name |
string User's last name. |
|
|
string User's email address. |
|
phone_number |
string User's phone number. |
|
created_at |
Timestamp when the user was created. |
|
updated_at |
Timestamp when the user was last updated. |
|
external_id |
string External identifier for federation with external identity systems. |
|
company_name |
string User's company name. |
|
department |
string User's department. |
|
job_title |
string User's job title. |
|
employee_id |
string User's employee ID |