Отмена приглашения или исключение организации из федерации
Отменяет приглашение организации в федерацию или исключает организацию из федерации. Запрос выполняется от имени организации, указанной в заголовке X-Yandex360-Org-Id.
Для федерации без администратора (closed) доступна только отмена приглашения, причем только организацией-инициатором приглашения.
Требуется разрешение directory:write_federations — управление федерациями.
Отправить запрос может администратор организации или сотрудник с ролью Менеджер федераций.
Request
PATCH
https://cloud-api.yandex.net/v1/directory/federations/{federation_id}/organizations/{organization_id}
Path parameters
|
Name |
Description |
|
federation_id |
Type: string Идентификатор федерации (UUID). Pattern: Example: `` |
|
organization_id |
Type: integer Идентификатор организации-участника. Min value: |
Headers
|
Name |
Description |
|
X-Yandex360-Org-Id |
Type: integer Организация, от имени которой выполняется запрос. Min value: |
Body
application/json
{
"status": "rejected",
"blacklist_scope": "example"
}
|
Name |
Description |
|
status |
Type: string Действие над участием — Enum: |
|
blacklist_scope |
Type: string Не передавать — при наличии поля запрос отклоняется. Pattern: Example: |
Responses
200 OK
Участие изменено. Ответ содержит публичные поля участия.
Body
application/json
{
"membership_id": "example",
"federation_id": "example",
"member_organization_id": 0,
"initiator_organization_id": 0,
"status": "requested",
"created_at": "example",
"updated_at": "example"
}
|
Name |
Description |
|
created_at |
Type: string Дата и время создания участия. Example: |
|
federation_id |
Type: string Идентификатор федерации (UUID). Example: |
|
initiator_organization_id |
Type: integer Идентификатор организации-инициатора приглашения. |
|
member_organization_id |
Type: integer Идентификатор организации-участника. |
|
membership_id |
Type: string Идентификатор участия (UUID). Example: |
|
status |
Type: string Статус участия. Возможные значения:
Enum: |
|
updated_at |
Type: string Дата и время последнего изменения участия. Example: |
400 Bad Request
Некорректный запрос.
Body
application/json
{
"error": "bad_request",
"description": "Bad request",
"message": "Bad request",
"details": {}
}
|
Name |
Description |
|
description |
Type: string Техническое описание ошибки. Example: |
|
error |
Type: string Код ошибки Example: |
|
message |
Type: string Сообщение об ошибке. Example: |
|
details |
Type: objectДополнительные детали ошибки Example
|
401 Unauthorized
Пользователь не авторизован.
Body
application/json
{
"error": "unauthorized",
"description": "Unauthorized",
"message": "Unauthorized",
"details": {}
}
|
Name |
Description |
|
description |
Type: string Техническое описание ошибки. Example: |
|
error |
Type: string Код ошибки Example: |
|
message |
Type: string Сообщение об ошибке. Example: |
|
details |
Type: objectДополнительные детали ошибки Example
|
403 Forbidden
Доступ к ресурсу запрещен. У пользователя или приложения недостаточно прав.
Body
application/json
{
"error": "forbidden",
"description": "Forbidden",
"message": "Forbidden",
"details": {}
}
|
Name |
Description |
|
description |
Type: string Техническое описание ошибки. Example: |
|
error |
Type: string Код ошибки Example: |
|
message |
Type: string Сообщение об ошибке. Example: |
|
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: |
|
error |
Type: string Код ошибки Example: |
|
message |
Type: string Сообщение об ошибке. Example: |
|
details |
Type: objectДополнительные детали ошибки Example
|
409 Conflict
Возможные ошибки:
- Участие организации в федерации уже существует.
- Участие организации в федерации уже существует.
Body
application/json
{
"error": "conflict",
"description": "Conflict",
"message": "Conflict",
"details": {}
}
|
Name |
Description |
|
description |
Type: string Техническое описание ошибки. Example: |
|
error |
Type: string Код ошибки Example: |
|
message |
Type: string Сообщение об ошибке. Example: |
|
details |
Type: objectДополнительные детали ошибки Example
|
422 Unprocessable Entity
Возможные ошибки:
- Функция недоступна.
- Недопустимые данные.
Body
application/json
{
"error": "feature_unavailable",
"description": "Функция недоступна.",
"message": "Функция недоступна.",
"details": {}
}
|
Name |
Description |
|
description |
Type: string Техническое описание ошибки. Example: |
|
error |
Type: string Код ошибки Example: |
|
message |
Type: string Сообщение об ошибке. Example: |
|
details |
Type: objectДополнительные детали ошибки Example
|