Изменение названия организации

Изменяет название организации.

Требуется разрешение directory:write_organization — редактирование организации.

Отправить запрос может администратор организации.

Request

PATCH

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

Path parameters

Name

Description

org_id

Type: integer

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

Body

application/json
{
  "name": "example"
}

Name

Description

name

Type: string

Новое название организации.

Example: example

Responses

200 OK

Название организации изменено.

Body

application/json
{
  "id": 1,
  "name": "example"
}

Name

Description

id

Type: integer

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

Min value: 1

name

Type: string

Название организации.

Example: 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
{}

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
{}
Предыдущая