Получение настроек SSO организации
Возвращает настройки SSO организации и публичные сертификаты поставщика удостоверений (IdP).
Требуется одно из разрешений:
directory:read_organization— чтение данных об организации;directory:write_organization— редактирование организации.
Отправить запрос может администратор организации.
Request
GET
https://cloud-api.yandex.net/v1/directory/organizations/{org_id}/settings/sso
Path parameters
|
Name |
Description |
|
org_id |
Type: integer Идентификатор организации. |
Responses
200 OK
Настройки SSO получены. Ответ содержит поля: entity_id (строка) — идентификатор конфигурации поставщика удостоверений (IdP); single_sign_on_service_url (строка) — URL сервиса единого входа поставщика удостоверений; client_id (строка или null) — идентификатор OAuth-клиента; certs (массив строк) — публичные сертификаты поставщика удостоверений, используются первые два: новый и старый; is_enabled (boolean) — включен ли SSO; is_department_sync_enabled (boolean) — включена ли синхронизация подразделений. При отсутствии организации, подтвержденного основного домена или конфигурации SSO возвращается 404.
403 Forbidden
Доступ к ресурсу запрещен. У пользователя или приложения недостаточно прав.
Body
application/json
{
"error": "forbidden",
"description": "Forbidden",
"message": "Forbidden",
"details": {}
}
|
Name |
Description |
|
description |
Type: string Техническое описание ошибки. Example: |
|
error |
Type: string Код ошибки Example: |
|
message |
Type: string Сообщение об ошибке. Example: |
|
details |
Type: objectДополнительные детали ошибки Example |
404 Not Found
Запрашиваемый ресурс не найден.
Body
application/json
{
"error": "not_found",
"description": "Not found",
"message": "Not found",
"details": {}
}
|
Name |
Description |
|
description |
Type: string Техническое описание ошибки. Example: |
|
error |
Type: string Код ошибки Example: |
|
message |
Type: string Сообщение об ошибке. Example: |
|
details |
Type: objectДополнительные детали ошибки Example |
422 Unprocessable Entity
Возможные ошибки:
- Feature unavailable
- Invalid data
Body
application/json
{
"error": "feature_unavailable",
"description": "Feature unavailable",
"message": "Feature unavailable",
"details": {}
}
|
Name |
Description |
|
description |
Type: string Техническое описание ошибки. Example: |
|
error |
Type: string Код ошибки Example: |
|
message |
Type: string Сообщение об ошибке. Example: |
|
details |
Type: objectДополнительные детали ошибки Example |