Identity Provider API, gRPC: UserService.GetPasswordChanges
Streams password changes for a IdentityHub sync agent to process.
gRPC request
rpc GetPasswordChanges (stream GetPasswordChangesRequest) returns (stream GetPasswordChangesResponse)
GetPasswordChangesRequest
{
"userpool_id": "string",
"agent_id": "string",
"offset": "int64"
}
Request from a IdentityHub sync agent to receive pending password changes.
|
Field |
Description |
|
userpool_id |
string Required field. ID of the userpool to receive password changes for. The maximum string length in characters is 50. |
|
agent_id |
string Required field. ID of the IdentityHub sync agent. The maximum string length in characters is 50. |
|
offset |
int64 Offset of the last successfully processed change. |
GetPasswordChangesResponse
{
"external_user_id": "string",
"password": "string",
"modifying_operation_id": "string",
"need_change": "bool",
"offset": "int64",
"expires_at": "google.protobuf.Timestamp",
"operation_expires_at": "google.protobuf.Timestamp",
"generated": "bool",
"old_password": "string"
}
A pending password change to be processed by a IdentityHub sync agent.
|
Field |
Description |
|
external_user_id |
string External identifier of the user whose password changed. |
|
password |
string The new password to write back to the directory. |
|
modifying_operation_id |
string ID of the operation that triggered this password change. |
|
need_change |
bool Whether the user must change their password on next login. |
|
offset |
int64 Offset of this change in the stream. |
|
expires_at |
Timestamp when the password expires. |
|
operation_expires_at |
Timestamp when the writeback operation expires. |
|
generated |
bool Whether the password was system-generated. |
|
old_password |
string The user's previous password. Present only for user-initiated changes |