Проверка доступности SSO организации

Проверяет условия включения SSO для организации. Запрос проверяет именно возможность включения SSO, а не работоспособность входа через поставщика удостоверений (IdP).

При недоступности возвращает причину: not available — возможность SSO недоступна организации; no domain — у организации нет основного домена; has pdd accounts — в организации есть аккаунты, созданные на ее домене — из-за этого нельзя включить SSO. При is_allowed=true поле reason отсутствует.

Требуется одно из разрешений:

  • directory:read_organization — чтение данных об организации;
  • directory:write_organization — редактирование организации.

Отправить запрос может администратор организации.

Request

GET

https://cloud-api.yandex.net/v1/directory/organizations/{org_id}/settings/sso/availability

Path parameters

Name

Description

org_id

Type: integer

Идентификатор организации.

Responses

200 OK

Условия включения SSO проверены.

Body

application/json
{
  "is_allowed": true,
  "reason": "not available"
}

Name

Description

is_allowed

Type: boolean

Выполнены ли условия включения SSO.

reason

Type: string

Причина недоступности SSO; присутствует при is_allowed=false.

Enum: not available, no domain, has pdd accounts

403 Forbidden

Доступ к ресурсу запрещен. У пользователя или приложения недостаточно прав.

Body

application/json
{
  "error": "forbidden",
  "description": "Forbidden",
  "message": "Forbidden",
  "details": {}
}

Name

Description

description

Type: string

Техническое описание ошибки.

Example: Forbidden

error

Type: string

Код ошибки

Example: forbidden

message

Type: string

Сообщение об ошибке.

Example: Forbidden

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: Not found

error

Type: string

Код ошибки

Example: not_found

message

Type: string

Сообщение об ошибке.

Example: Not found

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: Feature unavailable

error

Type: string

Код ошибки

Example: feature_unavailable

message

Type: string

Сообщение об ошибке.

Example: Feature unavailable

details
Type: object

Дополнительные детали ошибки

Example
{}
Предыдущая
Сохранение настроек
Следующая
Обзор