Identity Provider API, REST: User.SetPasswordHash
Sets a password hash for the specified user.
HTTP request
POST https://organization-manager.api.cloud.yandex.net/organization-manager/v1/idp/users/{userId}:setPasswordHash
Path parameters
Request to set a password hash for a user.
|
Field |
Description |
|
userId |
string Required field. ID of the user to set the password hash for. |
Body parameters
{
"hash": {
"passwordHash": "string",
"passwordHashType": "string"
}
}
Request to set a password hash for a user.
|
Field |
Description |
|
hash |
Password hash to set. |
PasswordHash
Password hash information.
|
Field |
Description |
|
passwordHash |
string Required field. The password hash string. |
|
passwordHashType |
enum (PasswordHashType) Required field. Type of the password hash.
|
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": "boolean",
"metadata": {
"userId": "string"
},
// Includes only one of the fields `error`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
}
// 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. |
|
createdAt |
string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
createdBy |
string ID of the user or service account who initiated the operation. |
|
modifiedAt |
string (date-time) The time when the Operation resource was last modified. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
done |
boolean 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. |
SetPasswordHashMetadata
Metadata for the UserService.SetPasswordHash operation.
|
Field |
Description |
|
userId |
string ID of the user whose password hash is being set. |
Status
The error result of the operation in case of failure or cancellation.
|
Field |
Description |
|
code |
integer (int32) Error code. An enum value of google.rpc.Code. |
|
message |
string An error message. |
|
details[] |
object A list of messages that carry the error details. |