Добавить участника в группу

  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-запрос

POST https://api360.yandex.net/directory/v1/org/{orgId}/groups/{groupId}/members

Path-параметры

orgId *

integer

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

groupId *

integer

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

orgId *

integer

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

groupId *

integer

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

Тело запроса

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

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

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

Поля

id *

string

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

type *

string

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

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

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

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

id *

string

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

type *

string

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

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

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

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

Ответы

Код 200

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

{
  "added": boolean,
  "id": string,
  "type": string
}
Скопировано

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

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

Поля

added

boolean

Признак добавления участника: true — добавлен; false — не добавлен.

id *

string

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

type *

string

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

added

boolean

Признак добавления участника: true — добавлен; false — не добавлен.

id *

string

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

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