---
metadata:
  - name: generator
    content: Diplodoc Platform v5.52.0
alternate:
  - https://yandex.ru/dev/api360-preview/doc/ru/ref/OrganizationsService/OrganizationsService_ChangeIdentity.md
  - href: ru/ref/OrganizationsService/OrganizationsService_ChangeIdentity.md
    type: text/markdown
    title: Markdown version
  - href: ../../llms.txt
    type: text/markdown
    title: llms.txt
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/api360-preview/doc/ru/llms.txt

<div class="openapi">

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

<!-- markdownlint-disable-file -->

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

{% note info %}

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

{% endnote %}

**Пример:**
```bash
curl --request POST https://api360.yandex.net/directory/v1/org/{orgId}/identity \
    --header 'Authorization: OAuth token'
```

## Request

<div class="openapi__requests">

<div class="openapi__request__wrapper" style="--method: var(--dc-openapi-methods-post);margin-bottom: 12px">

<div class="openapi__request">

POST {.openapi__method}
```text translate=no
https://api360.yandex.net/directory/v1/org/{orgId}/identity
```

</div>

</div>

</div>

### Path parameters

#|
|| **Name** | **Description** ||
||

_orgId_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

Идентификатор организации.
{.table-cell}
||
|#{.json-schema-properties}

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "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
    }
  }
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_entityId_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_idp_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [v1Config](#entity-v1Config)

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

{% cut "**Example**" %}{.json-schema-example}

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

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

</div>

<div class="openapi-entity">

### ConfigOAuthConfig {#entity-ConfigOAuthConfig}

Параметры OAuth.

#|
|| **Name** | **Description** ||
||

_clientId_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "clientId": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### ConfigAbstractService {#entity-ConfigAbstractService}

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

#|
|| **Name** | **Description** ||
||

_binding_{.json-schema-reset .json-schema-property}
{.table-cell}|
**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:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_url_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "url": "example",
  "binding": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### ConfigX509Cert {#entity-ConfigX509Cert}

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

#|
|| **Name** | **Description** ||
||

_new_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_old_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "new": "example",
  "old": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### ConfigSAMLConfig {#entity-ConfigSAMLConfig}

Параметры SAML.

#|
|| **Name** | **Description** ||
||

_allowPortalAccountExtension_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Возможность для пользователей с почтой на домене организации расширять аккаунты федеративным алиасом.
Возможные значения: `true` — федеративные алиасы могут использоваться, `false` — допустимы только адреса почты на домене организации. Значение по умолчанию — `false`.
{.table-cell}
||
||

_disableJitProvisioning_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Признак отключенной автоматической регистрации пользователя при входе через IdP.
Возможные значения: `true` — автоматическая регистрация отключена, новых пользователей на домене организации можно добавить только через SCIM; `false` — автоматическая регистрация возможна.
Значение по умолчанию — `false`.
{.table-cell}
||
||

_logoutUrl_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [ConfigAbstractService](#entity-ConfigAbstractService)

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

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

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "url": "example",
  "binding": "example"
}
```

{% endcut %}
{.table-cell}
||
||

_lowercaseUrlencoding_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Признак применения метода кодирования URL с использованием нижнего регистра.
{.table-cell}
||
||

_sso_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [ConfigAbstractService](#entity-ConfigAbstractService)

URL-адрес, который используется для инициирования процесса аутентификации через систему единого входа (SSO).

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

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "url": "example",
  "binding": "example"
}
```

{% endcut %}
{.table-cell}
||
||

_x509Cert_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [ConfigX509Cert](#entity-ConfigX509Cert)

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

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "new": "example",
  "old": "example"
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "sso": {
    "url": "example",
    "binding": "example"
  },
  "logoutUrl": null,
  "x509Cert": {
    "new": "example",
    "old": "example"
  },
  "lowercaseUrlencoding": true,
  "disableJitProvisioning": true,
  "allowPortalAccountExtension": true
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### v1Config {#entity-v1Config}

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

#|
|| **Name** | **Description** ||
||

_enabled_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Признак включенной технологии SSO для организации.
Возможные значения: `true` — техология SSO включена; `false` — запрещены как вход с использованием SSO, так и синхронизация контактов через SCIM.
Значение по умолчанию — `true`.
{.table-cell}
||
||

_oauthConfig_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [ConfigOAuthConfig](#entity-ConfigOAuthConfig)

Параметры OAuth.

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "clientId": "example"
}
```

{% endcut %}
{.table-cell}
||
||

_samlConfig_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [ConfigSAMLConfig](#entity-ConfigSAMLConfig)

Параметры SAML.

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "sso": {
    "url": "example",
    "binding": "example"
  },
  "logoutUrl": null,
  "x509Cert": {
    "new": "example",
    "old": "example"
  },
  "lowercaseUrlencoding": true,
  "disableJitProvisioning": true,
  "allowPortalAccountExtension": true
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

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

{% endcut %}

</div>

## Responses

<div class="openapi__response__code__200">

## 200 OK

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

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "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
    }
  }
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_entityId_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_idp_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [v1Config](#entity-v1Config)

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

{% cut "**Example**" %}{.json-schema-example}

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

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

<div class="openapi__response__code__400">

## 400 Bad Request

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

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_code_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Код ошибки.
{.table-cell}
||
||

_details_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [protobufAny](#entity-protobufAny)[]

Дополнительные сведения об ошибке.

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "@type": "example"
  }
]
```

{% endcut %}
{.table-cell}
||
||

_message_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Описание ошибки.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

</div>

<div class="openapi-entity">

### protobufAny {#entity-protobufAny}

#|
|| **Name** | **Description** ||
||

_@type_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_[additional]_{.json-schema-reset .json-schema-additional-property}
{.table-cell}|
**Type**: unknown

_Example:_{.json-schema-reset .json-schema-example} `null`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "@type": "example"
}
```

{% endcut %}

</div>

</div>

<div class="openapi__response__code__401">

## 401 Unauthorized

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

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_code_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Код ошибки.
{.table-cell}
||
||

_details_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [protobufAny](#entity-protobufAny)[]

Дополнительные сведения об ошибке.

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "@type": "example"
  }
]
```

{% endcut %}
{.table-cell}
||
||

_message_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Описание ошибки.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

<div class="openapi__response__code__403">

## 403 Forbidden

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

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_code_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Код ошибки.
{.table-cell}
||
||

_details_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [protobufAny](#entity-protobufAny)[]

Дополнительные сведения об ошибке.

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "@type": "example"
  }
]
```

{% endcut %}
{.table-cell}
||
||

_message_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Описание ошибки.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

<div class="openapi__response__code__404">

## 404 Not Found

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

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_code_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Код ошибки.
{.table-cell}
||
||

_details_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [protobufAny](#entity-protobufAny)[]

Дополнительные сведения об ошибке.

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "@type": "example"
  }
]
```

{% endcut %}
{.table-cell}
||
||

_message_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Описание ошибки.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

<div class="openapi__response__code__500">

## 500 Internal Server Error

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

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_code_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Код ошибки.
{.table-cell}
||
||

_details_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [protobufAny](#entity-protobufAny)[]

Дополнительные сведения об ошибке.

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "@type": "example"
  }
]
```

{% endcut %}
{.table-cell}
||
||

_message_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Описание ошибки.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

</div>

[*Deprecated]: No longer supported, please use an alternative and newer version.