Identity Provider API, REST: Userpool.Get
Returns the specified userpool.
To get the list of available userpools, make a List request.
HTTP request
GET https://organization-manager.api.cloud.yandex.net/organization-manager/v1/idp/userpools/{userpoolId}
Path parameters
Request to get a userpool.
|
Field |
Description |
|
userpoolId |
string Required field. ID of the userpool to return. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"organizationId": "string",
"name": "string",
"description": "string",
"labels": "object",
"createdAt": "string",
"updatedAt": "string",
"domains": [
"string"
],
"status": "string",
"userSettings": {
"allowEditSelfPassword": "boolean",
"allowEditSelfInfo": "boolean",
"allowEditSelfContacts": "boolean",
"allowEditSelfLogin": "boolean"
},
"passwordQualityPolicy": {
"allowSimilar": "boolean",
"maxLength": "string",
"minLength": "string",
"matchLength": "string",
"requiredClasses": {
"lowers": "boolean",
"uppers": "boolean",
"digits": "boolean",
"specials": "boolean"
},
"minLengthByClassSettings": {
"one": "string",
"two": "string",
"three": "string"
}
},
"passwordLifetimePolicy": {
"minDaysCount": "string",
"maxDaysCount": "string"
},
"bruteforceProtectionPolicy": {
"window": "string",
"block": "string",
"attempts": "string"
}
}
A userpool is a container for users in the Identity Provider system.
|
Field |
Description |
|
id |
string Unique identifier of the userpool. |
|
organizationId |
string ID of the organization this userpool belongs to. |
|
name |
string Name of the userpool. |
|
description |
string Description of the userpool. |
|
labels |
object (map<string, string>) Resource labels as key:value pairs. |
|
createdAt |
string (date-time) Timestamp when the userpool was created. 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 |
|
updatedAt |
string (date-time) Timestamp when the userpool was last updated. 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 |
|
domains[] |
string List of domains associated with this userpool. |
|
status |
enum (Status) Current status of the userpool.
|
|
userSettings |
User settings for this userpool. |
|
passwordQualityPolicy |
Password quality policy for this userpool. |
|
passwordLifetimePolicy |
Password lifetime policy for this userpool. |
|
bruteforceProtectionPolicy |
Bruteforce protection policy for this userpool. |
UserSettings
Settings that control user capabilities within a userpool.
|
Field |
Description |
|
allowEditSelfPassword |
boolean Whether users can change their own passwords. |
|
allowEditSelfInfo |
boolean Whether users can edit their own profile information. |
|
allowEditSelfContacts |
boolean Whether users can edit their own contact information. |
|
allowEditSelfLogin |
boolean Whether users can edit their own login information. |
PasswordQualityPolicy
Policy that defines password quality requirements.
|
Field |
Description |
|
allowSimilar |
boolean Whether passwords similar to previous ones are allowed. |
|
maxLength |
string (int64) Maximum password length. Zero means no maximum length is enforced. |
|
minLength |
string (int64) Minimum password length. |
|
matchLength |
string (int64) Minimum length of substrings to check for similarity to vulnerable sequences. |
|
requiredClasses |
Character classes required in passwords. |
|
minLengthByClassSettings |
Minimum length requirements based on character class diversity. |
RequiredClasses
Character classes that can be required in passwords.
|
Field |
Description |
|
lowers |
boolean Whether lowercase letters are required. |
|
uppers |
boolean Whether uppercase letters are required. |
|
digits |
boolean Whether digits are required. |
|
specials |
boolean Whether special characters are required. |
MinLengthByClassSettings
Minimum password length requirements based on character class diversity.
|
Field |
Description |
|
one |
string (int64) Minimum length for passwords with one character class. |
|
two |
string (int64) Minimum length for passwords with two character classes. |
|
three |
string (int64) Minimum length for passwords with three character classes. |
PasswordLifetimePolicy
Policy that defines password lifetime requirements.
|
Field |
Description |
|
minDaysCount |
string (int64) Minimum number of days before a password can be changed. |
|
maxDaysCount |
string (int64) Maximum number of days a password remains valid. |
BruteforceProtectionPolicy
Policy that defines protection against brute force attacks.
|
Field |
Description |
|
window |
string (duration) Time window for counting failed authentication attempts. |
|
block |
string (duration) Duration of the block after too many failed attempts. |
|
attempts |
string (int64) Number of failed attempts allowed within the window before blocking. |