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

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

Примечание

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

Пример:

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

Request

GET

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

Path parameters

Name

Description

orgId

Type: integer

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

Responses

200 OK

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

Body

application/json

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

Name

Description

entityId

Type: string

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

Example: example

idp

Type: v1Config

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

Example

{
  "enabled": true,
  "oauthConfig": {
    "clientId": "example"
  },
  "samlConfig": {
    "sso": {
      "url": "example",
      "binding": "example"
    },
    "logoutUrl": null,
    "x509Cert": {
      "new": "example",
      "old": "example"
    },
    "lowercaseUrlencoding": true,
    "disableJitProvisioning": true,
    "allowPortalAccountExtension": true
  }
}

ConfigOAuthConfig

Параметры OAuth.

Name

Description

clientId

Type: string

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

Example: example

Example

{
  "clientId": "example"
}

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 (перенаправление). Значение по умолчанию — перенаправление.

Example: example

url

Type: string

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

Example: example

Example

{
  "url": "example",
  "binding": "example"
}

ConfigX509Cert

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

Name

Description

new

Type: string

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

Example: example

old

Type: string

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

Example: example

Example

{
  "new": "example",
  "old": "example"
}

ConfigSAMLConfig

Параметры SAML.

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

Example

{
  "sso": {
    "url": "example",
    "binding": "example"
  },
  "logoutUrl": null,
  "x509Cert": {
    "new": "example",
    "old": "example"
  },
  "lowercaseUrlencoding": true,
  "disableJitProvisioning": true,
  "allowPortalAccountExtension": true
}

v1Config

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

Name	Description
enabled	Type: boolean Признак включенной технологии SSO для организации. Возможные значения: `true` — техология SSO включена; `false` — запрещены как вход с использованием SSO, так и синхронизация контактов через SCIM. Значение по умолчанию — `true`.
oauthConfig	Type: ConfigOAuthConfig Параметры OAuth. Example `{ "clientId": "example" }`
samlConfig	Type: ConfigSAMLConfig Параметры SAML. Example `{ "sso": { "url": "example", "binding": "example" }, "logoutUrl": null, "x509Cert": { "new": "example", "old": "example" }, "lowercaseUrlencoding": true, "disableJitProvisioning": true, "allowPortalAccountExtension": true }`

Example

{
  "enabled": true,
  "oauthConfig": {
    "clientId": "example"
  },
  "samlConfig": {
    "sso": {
      "url": "example",
      "binding": "example"
    },
    "logoutUrl": null,
    "x509Cert": {
      "new": "example",
      "old": "example"
    },
    "lowercaseUrlencoding": true,
    "disableJitProvisioning": true,
    "allowPortalAccountExtension": true
  }
}

400 Bad Request

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

Body

application/json

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

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

protobufAny

Name

Description

@type

Type: string

Example: example

[additional]

Type: unknown

Example: null

Example

{
  "@type": "example"
}

401 Unauthorized

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

Body

application/json

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

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

403 Forbidden

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

Body

application/json

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

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

404 Not Found

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

Body

application/json

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

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

500 Internal Server Error

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

Body

application/json

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

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

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

Посмотреть список организаций

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