Изменить параметры федерации удостоверений

Изменить параметры федерации удостоверений для организации.

Примечание

Требуется разрешение на изменение данных об организациях.

Пример:

curl --request POST https://api360.yandex.net/directory/v1/org/{orgId}/identity \
    --header 'Authorization: OAuth token'

Request

POST

https://api360.yandex.net/directory/v1/org/{orgId}/identity

Path parameters

Name

Description

orgId*

Type: integer<int64>

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

Body

application/json

{
    "entityId": "string",
    "idp": {
        "enabled": false,
        "oauthConfig": {
            "clientId": "string"
        },
        "samlConfig": {
            "sso": {
                "url": "string",
                "binding": "string"
            },
            "logoutUrl": {
                "url": "string",
                "binding": "string"
            },
            "x509Cert": {
                "new": "string",
                "old": "string"
            },
            "lowercaseUrlencoding": false,
            "disableJitProvisioning": false,
            "allowPortalAccountExtension": false
        }
    }
}

Name

Description

entityId*

Type: string

Идентификатор экземпляра записи о федерации удостоверений.

idp

Type: v1Config

Параметры поставщика удостоверений.

v1Config

Параметры поставщика удостоверений.

Name	Description
enabled	Type: boolean Признак включенной технологии SSO для организации. Возможные значения: `true` — техология SSO включена; `false` — запрещены как вход с использованием SSO, так и синхронизация контактов через SCIM. Значение по умолчанию — `true`.
oauthConfig	Type: ConfigOAuthConfig Параметры OAuth.
samlConfig	Type: ConfigSAMLConfig Параметры SAML.

ConfigOAuthConfig

Параметры OAuth.

Name

Description

clientId

Type: string

Уникальный идентификатор OAuth-приложения.

ConfigSAMLConfig

Параметры SAML.

Name	Description
allowPortalAccountExtension	Type: boolean Возможность для пользователей с почтой на домене организации расширять аккаунты федеративным алиасом. Возможные значения: `true` — федеративные алиасы могут использоваться, `false` — допустимы только адреса почты на домене организации. Значение по умолчанию — `false`.
disableJitProvisioning	Type: boolean Признак отключенной автоматической регистрации пользователя при входе через IdP. Возможные значения: `true` — автоматическая регистрация отключена, новых пользователей на домене организации можно добавить только через SCIM; `false` — автоматическая регистрация возможна. Значение по умолчанию — `false`.
logoutUrl	Type: ConfigAbstractService URL-адрес, который используется для инициирования процесса выхода пользователя из системы.
lowercaseUrlencoding	Type: boolean Признак применения метода кодирования URL с использованием нижнего регистра.
sso	Type: ConfigAbstractService URL-адрес, который используется для инициирования процесса аутентификации через систему единого входа (SSO).
x509Cert	Type: ConfigX509Cert Обновление сертификата X.509, используемого для для SAML аутентификации.

ConfigAbstractService

URL-адрес, который используется для инициирования процесса входа (для sso) / выхода (для logoutUrl).

Name

Description

binding

Type: string

Привязка, определяющая порядок использования транспортных протоколов для передачи сообщений SAML. Возможные значения: urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST — привязка HTTP-POST (постинг); urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect — привязка HTTP-Redirect (перенаправление). Значение по умолчанию — перенаправление.

url

Type: string

URL-адрес ресурса.

ConfigX509Cert

Обновление сертификата X.509, используемого для для SAML аутентификации.

Name

Description

new

Type: string

Новый сертификат.

old

Type: string

Старый сертификат.

Responses

200 OK

Запрос успешно выполнен.

Body

application/json

{
    "entityId": "string",
    "idp": {
        "enabled": false,
        "oauthConfig": {
            "clientId": "string"
        },
        "samlConfig": {
            "sso": {
                "url": "string",
                "binding": "string"
            },
            "logoutUrl": {
                "url": "string",
                "binding": "string"
            },
            "x509Cert": {
                "new": "string",
                "old": "string"
            },
            "lowercaseUrlencoding": false,
            "disableJitProvisioning": false,
            "allowPortalAccountExtension": false
        }
    }
}

Name

Description

entityId

Type: string

Идентификатор экземпляра записи о федерации удостоверений.

idp

Type: v1Config

Параметры поставщика удостоверений.

400 Bad Request

Некорректный запрос.

Body

application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "@type": "string"
        }
    ]
}

Name	Description
code	Type: integer<int32> Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке.
message	Type: string Описание ошибки.

protobufAny

Name	Description
@type	Type: string
[additional]	Type: any

401 Unauthorized

Пользователь не авторизован.

Body

application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "@type": "string"
        }
    ]
}

Name	Description
code	Type: integer<int32> Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке.
message	Type: string Описание ошибки.

403 Forbidden

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

Body

application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "@type": "string"
        }
    ]
}

Name	Description
code	Type: integer<int32> Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке.
message	Type: string Описание ошибки.

404 Not Found

Запрашиваемый ресурс не найден.

Body

application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "@type": "string"
        }
    ]
}

Name	Description
code	Type: integer<int32> Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке.
message	Type: string Описание ошибки.

500 Internal Server Error

Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.

Body

application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "@type": "string"
        }
    ]
}

Name	Description
code	Type: integer<int32> Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке.
message	Type: string Описание ошибки.

Была ли статья полезна?

Посмотреть параметры федерации удостоверений

Обзор