Переименование федерации

Переименовывает федерацию. Для открытой федерации запрос выполняет организация-владелец, для закрытой — принятый участник. В режиме только для чтения переименование недоступно, как и для закрытой федерации с несколькими участниками.

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

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

Request

PATCH

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

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

Headers

Name

Description

X-Yandex360-Org-Id

Type: integer

Организация, от имени которой выполняется запрос.

Min value: 1

Body

application/json

{
  "name": "example"
}

Name

Description

name

Type: string

Новое название федерации.

Example: example

Responses

200 OK

Федерация переименована. Ответ содержит публичные поля федерации.

Body

application/json

{
  "id": "example",
  "name": "example",
  "type": "open",
  "members_count": 0,
  "created_at": "example",
  "updated_at": "example",
  "owner_organization_id": 0
}

Name	Description
created_at	Type: string Дата и время создания федерации. Example: `example`
id	Type: string Идентификатор федерации (UUID). Example: `example`
members_count	Type: integer Количество участников федерации.
name	Type: string Название федерации. Example: `example`
type	Type: string Тип федерации: `open` — открытая: федерацией управляет организация-владелец; `closed` — закрытая: федерацией управляют принятые участники, постоянный владелец не назначается. Enum: `open`, `closed`
updated_at	Type: string Дата и время последнего изменения федерации. Example: `example`
owner_organization_id	Type: integer Идентификатор организации-владельца открытой федерации. У закрытой федерации поле отсутствует или содержит `null`.

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

{}

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

Создание федерации

Получение списка организаций