Изменить руководителей группы

  1. HTTP-запрос
  2. Path-параметры
  3. Тело запроса
    1. Представление
    2. Поля
  4. Ответы
    1. Код 200
      1. Представление
      2. Поля
    2. Код 401
      1. Представление
      2. Поля
    3. Код 403
      1. Представление
      2. Поля
    4. Код 404
      1. Представление
      2. Поля
    5. Код 500
      1. Представление
      2. Поля

Назначает руководителей группы. Руководителем группы может стать любой сотрудник организации. Изменяет сразу весь список руководителей.

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

HTTP-запрос

PUT https://api360.yandex.net/directory/v1/org/{orgId}/groups/{groupId}/admins

Path-параметры

orgId *

integer

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

groupId *

integer

Идентификатор группы.

orgId *

integer

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

groupId *

integer

Идентификатор группы.

Тело запроса

{
  "adminIds": [
    "string"
  ]
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

adminIds[]

array

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

adminIds[]

array

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

Ответы

Код 200

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

{
  "adminIds": [
    string
  ],
  "aliases": [
    string
  ],
  "authorId": string,
  "createdAt": string,
  "description": string,
  "email": string,
  "externalId": string,
  "id": integer,
  "label": string,
  "memberOf": [
    integer
  ],
  "members": [
    {
      "id": string,
      "type": string
    }
  ],
  "membersCount": integer,
  "name": string,
  "removed": boolean,
  "type": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

adminIds[]

array

Идентификаторы руководетелей группы.

aliases[]

array

Алиасы почтовых ящиков группы.

authorId

string

Идентификатор создателя группы.

createdAt

string

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

description

string

Описание группы.

email

string

Адрес почтовой рассылки группы.

externalId

string

Произвольный внешний идентификатор группы.

id

integer

Идентификатор группы.

label

string

Имя почтовой рассылки группы. Например, для адреса new-group@ваш-домен.ru имя почтовой рассылки — это new-group.

memberOf[]

array

Идентификаторы групп, в которые входит эта группа.

members[]

array

Участники группы.

members[].id

string

Идентификатор участника группы.

members[].type

string

Тип участника группы.

  • user: Сотрудник.
  • group: Группа.
  • department: Подразделение.

Значение по умолчанию: user.

Возможные значения
  1. user
  2. group
  3. department

membersCount

integer

Количество участников группы.

name

string

Название группы.

removed

boolean

Признак удаленной группы: true — группа удалена; false — группа действующая.

type

string

Тип группы.

adminIds[]

array

Идентификаторы руководетелей группы.

aliases[]

array

Алиасы почтовых ящиков группы.

authorId

string

Идентификатор создателя группы.

createdAt

string

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

description

string

Описание группы.

email

string

Адрес почтовой рассылки группы.

externalId

string

Произвольный внешний идентификатор группы.

id

integer

Идентификатор группы.

label

string

Имя почтовой рассылки группы. Например, для адреса new-group@ваш-домен.ru имя почтовой рассылки — это new-group.

memberOf[]

array

Идентификаторы групп, в которые входит эта группа.

members[]

array

Участники группы.

members[].id

string

Идентификатор участника группы.

members[].type

string

Тип участника группы.

  • user: Сотрудник.
  • group: Группа.
  • department: Подразделение.

Значение по умолчанию: user.

Возможные значения
  1. user
  2. group
  3. department

membersCount

integer

Количество участников группы.

name

string

Название группы.

removed

boolean

Признак удаленной группы: true — группа удалена; false — группа действующая.

type

string

Тип группы.

Код 401

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

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

integer

details[]

array

details[].@type

string

message

string

code

integer

details[]

array

details[].@type

string

message

string

Код 403

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

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

integer

details[]

array

details[].@type

string

message

string

code

integer

details[]

array

details[].@type

string

message

string

Код 404

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

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

integer

details[]

array

details[].@type

string

message

string

code

integer

details[]

array

details[].@type

string

message

string

Код 500

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

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

integer

details[]

array

details[].@type

string

message

string

code

integer

details[]

array

details[].@type

string

message

string