Сохранение настроек SSO организации

Создает или обновляет настройки SSO организации. Для создания и обновления нужны подтвержденный основной домен и доступность SSO — проверьте их с помощью запроса «Проверить доступность SSO организации».

Если SSO настроен сразу для нескольких организаций, при обновлении общей конфигурации изменения затрагивают все связанные с ней организации.

Требуется разрешение directory:write_organization — редактирование организации.

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

Request

PUT

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

Path parameters

Name

Description

org_id

Type: integer

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

Body

application/json
{
  "entity_id": "example",
  "single_sign_on_service_url": "example",
  "certs": [
    "example"
  ],
  "client_id": "example",
  "is_department_sync_enabled": true
}

Name

Description

certs

Type: string[]

Публичные сертификаты поставщика удостоверений. Используются первые два сертификата — новый и старый.

Example
[
  "example"
]

entity_id

Type: string

Идентификатор конфигурации поставщика удостоверений (IdP).

Example: example

single_sign_on_service_url

Type: string

URL сервиса единого входа поставщика удостоверений.

Example: example

client_id

Type: string

Идентификатор OAuth-клиента. Если поле не передать, значение client_id сбросится, а provisioning (автоматическое создание учетных записей) отключится. Явный null и пустая строка не принимаются.

Min length: 1

Example: example

is_department_sync_enabled

Type: boolean

Синхронизация подразделений. При обновлении, если поле не передать, сохранится текущее значение; при создании значение по умолчанию — false.

Responses

200 OK

Настройки созданы или обновлены. Ответ имеет тот же формат, что и GET настроек SSO: entity_id (строка) — идентификатор конфигурации поставщика удостоверений (IdP); single_sign_on_service_url (строка) — URL сервиса единого входа поставщика удостоверений; client_id (строка) — идентификатор OAuth-клиента, пустая строка при отсутствии; certs (массив строк) — публичные сертификаты поставщика удостоверений: новый и старый; is_enabled и is_department_sync_enabled — boolean.

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
{}

409 Conflict

SSO configuration exists with different settings

Body

application/json
{
  "error": "config_exists",
  "description": "SSO configuration exists with different settings",
  "message": "SSO configuration exists with different settings",
  "details": {}
}

Name

Description

description

Type: string

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

Example: SSO configuration exists with different settings

error

Type: string

Код ошибки

Example: config_exists

message

Type: string

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

Example: SSO configuration exists with different settings

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
{}
Предыдущая
Получение настроек
Следующая
Проверка доступности