Приглашение организации в федерацию

Отправляет приглашение организации вступить в федерацию. Приглашение создает у организации участие со статусом requested; принять или отклонить его должна приглашенная организация.

Перед созданием приглашения проверяются права организации, лимит участников и отсутствие активного приглашения или участия. В режиме только для чтения создать приглашение нельзя.

Требуется разрешение directory:write_federations — управление федерациями.

Отправить запрос может администратор организации или сотрудник с ролью Менеджер федераций.

Request

POST

https://cloud-api.yandex.net/v1/directory/federations/{federation_id}/organizations

Path parameters

Name

Description

federation_id

Type: string

Идентификатор федерации (UUID).

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Example: ``

Body

application/json
{
  "initiator_organization_id": 1,
  "member_organization_id": 1
}

Name

Description

initiator_organization_id

Type: integer

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

Min value: 1

member_organization_id

Type: integer

Идентификатор приглашаемой организации.

Min value: 1

Responses

201 Created

Приглашение создано. Ответ содержит публичные поля участия.

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: example

federation_id

Type: string

Идентификатор федерации (UUID).

Example: example

initiator_organization_id

Type: integer

Идентификатор организации-инициатора приглашения.

member_organization_id

Type: integer

Идентификатор организации-участника.

membership_id

Type: string

Идентификатор участия (UUID).

Example: example

status

Type: string

Статус участия. Возможные значения:

  • requested — приглашение отправлено;
  • accepted — приглашение принято, организация участвует в федерации;
  • rejected — приглашение отклонено или отменено;
  • terminated — участие прекращено.

Enum: requested, accepted, rejected, terminated

updated_at

Type: string

Дата и время последнего изменения участия.

Example: example

400 Bad Request

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

Body

application/json
{
  "error": "bad_request",
  "description": "Bad request",
  "message": "Bad request",
  "details": {}
}

Name

Description

description

Type: string

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

Example: Bad request

error

Type: string

Код ошибки

Example: bad_request

message

Type: string

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

Example: Bad request

details
Type: object

Дополнительные детали ошибки

Example
{}

401 Unauthorized

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

Body

application/json
{
  "error": "unauthorized",
  "description": "Unauthorized",
  "message": "Unauthorized",
  "details": {}
}

Name

Description

description

Type: string

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

Example: Unauthorized

error

Type: string

Код ошибки

Example: unauthorized

message

Type: string

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

Example: Unauthorized

details
Type: object

Дополнительные детали ошибки

Example
{}

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

Возможные ошибки:

  • Federation membership already exists
  • Federation membership already exists

Body

application/json
{
  "error": "conflict",
  "description": "Conflict",
  "message": "Conflict",
  "details": {}
}

Name

Description

description

Type: string

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

Example: Conflict

error

Type: string

Код ошибки

Example: conflict

message

Type: string

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

Example: Conflict

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
{}
Предыдущая
Получение списка организаций
Следующая
Получение информации об организации