Изменить список участников группы

  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}/members

Path-параметры

orgId *

integer

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

groupId *

integer

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

orgId *

integer

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

groupId *

integer

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

Тело запроса

{
  "members": [
    {
      "id": string,
      "type": string
    }
  ]
}
Скопировано

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

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

Поля

members[]

array

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

members[].id

string

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

members[].type

string

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

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

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

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

members[]

array

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

members[].id

string

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

members[].type

string

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

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

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

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

Ответы

Код 200

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

{
  "departments": [
    {
      "id": integer,
      "membersCount": integer,
      "name": string
    }
  ],
  "groups": [
    {
      "id": integer,
      "membersCount": integer,
      "name": string
    }
  ],
  "users": [
    {
      "avatarId": string,
      "departmentId": integer,
      "email": string,
      "gender": string,
      "id": string,
      "name": {
        "first": string,
        "last": string,
        "middle": string
      },
      "nickname": string,
      "position": string
    }
  ]
}
Скопировано

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

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

Поля

departments[]

array

Подразделения.

departments[].id

integer

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

departments[].membersCount

integer

Количество сотрудников подразделения с учетом вложенных подразделений.

departments[].name

string

Название подразделения.

groups[]

array

Группы.

groups[].id

integer

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

groups[].membersCount

integer

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

groups[].name

string

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

users[]

array

Сотрудники.

users[].avatarId

string

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

users[].departmentId

integer

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

users[].email

string

Основной адрес электронной почты сотрудника.

users[].gender

string

Пол сотрудника.

users[].id

string

Идентификатор сотрудника.

users[].name

object

ФИО сотрудника.

users[].name.first

string

Имя сотрудника.

users[].name.last

string

Фамилия сотрудника.

users[].name.middle

string

Отчество сотрудника.

users[].nickname

string

Логин сотрудника.

users[].position

string

Должность сотрудника.

departments[]

array

Подразделения.

departments[].id

integer

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

departments[].membersCount

integer

Количество сотрудников подразделения с учетом вложенных подразделений.

departments[].name

string

Название подразделения.

groups[]

array

Группы.

groups[].id

integer

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

groups[].membersCount

integer

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

groups[].name

string

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

users[]

array

Сотрудники.

users[].avatarId

string

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

users[].departmentId

integer

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

users[].email

string

Основной адрес электронной почты сотрудника.

users[].gender

string

Пол сотрудника.

users[].id

string

Идентификатор сотрудника.

users[].name

object

ФИО сотрудника.

users[].name.first

string

Имя сотрудника.

users[].name.last

string

Фамилия сотрудника.

users[].name.middle

string

Отчество сотрудника.

users[].nickname

string

Логин сотрудника.

users[].position

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