Создать группу
Создает новую группу. Пользователь, от имени которого выполняется запрос, не включается в состав группы.
HTTP-запрос
POST https://api360.yandex.net/directory/v1/org/{orgId}/groups
Path-параметры
* Обязательный параметр
Тело запроса
{ "adminIds": [ string ], "description": string, "externalId": string, "label": string, "members": [ { "id": string, "type": string } ], "name": string }
Скопировано
Представление
Поля
adminIds[] | array Идентификаторы сотрудников организации, котрые являются руководителями группы. |
description | string Описание группы. |
externalId | string Произвольный внешний идентификатор группы. |
label | string Имя почтовой рассылки группы. Например, для адреса |
members[] | array Участники группы. |
members[]. | string Идентификатор участника группы. |
members[]. | string Тип участника группы.
Значение по умолчанию:
|
name * | string Название группы. |
adminIds[] | array Идентификаторы сотрудников организации, котрые являются руководителями группы. |
description | string Описание группы. |
externalId | string Произвольный внешний идентификатор группы. |
label | string Имя почтовой рассылки группы. Например, для адреса |
members[] | array Участники группы. |
members[]. | string Идентификатор участника группы. |
members[]. | string Тип участника группы.
Значение по умолчанию:
|
name * | string Название группы. |
* Обязательный параметр
Ответы
Код 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 Описание группы. |
| string Адрес почтовой рассылки группы. |
externalId | string Произвольный внешний идентификатор группы. |
id | integer Идентификатор группы. |
label | string Имя почтовой рассылки группы. Например, для адреса |
memberOf[] | array Идентификаторы групп, в которые входит эта группа. |
members[] | array Участники группы. |
members[]. | string Идентификатор участника группы. |
members[]. | string Тип участника группы.
Значение по умолчанию:
|
membersCount | integer Количество участников группы. |
name * | string Название группы. |
removed | boolean Признак удаленной группы: |
type | string Тип группы. |
adminIds[] | array Идентификаторы руководетелей группы. |
aliases[] | array Алиасы почтовых ящиков группы. |
authorId | string Идентификатор создателя группы. |
createdAt | string Дата и время создания группы. |
description | string Описание группы. |
| string Адрес почтовой рассылки группы. |
externalId | string Произвольный внешний идентификатор группы. |
id | integer Идентификатор группы. |
label | string Имя почтовой рассылки группы. Например, для адреса |
memberOf[] | array Идентификаторы групп, в которые входит эта группа. |
members[] | array Участники группы. |
members[]. | string Идентификатор участника группы. |
members[]. | string Тип участника группы.
Значение по умолчанию:
|
membersCount | integer Количество участников группы. |
name * | string Название группы. |
removed | boolean Признак удаленной группы: |
type | string Тип группы. |
* Обязательный параметр
Код 401
Пользователь не авторизован.
{ "code": integer, "details": [ { "@type": string } ], "message": string }
Скопировано
Представление
Поля
code | integer |
details[] | array |
details[]. | string |
message | string |
code | integer |
details[] | array |
details[]. | string |
message | string |
* Обязательный параметр
Код 403
У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен.
{ "code": integer, "details": [ { "@type": string } ], "message": string }
Скопировано
Представление
Поля
code | integer |
details[] | array |
details[]. | string |
message | string |
code | integer |
details[] | array |
details[]. | string |
message | string |
* Обязательный параметр
Код 404
Запрашиваемый ресурс не найден.
{ "code": integer, "details": [ { "@type": string } ], "message": string }
Скопировано
Представление
Поля
code | integer |
details[] | array |
details[]. | string |
message | string |
code | integer |
details[] | array |
details[]. | string |
message | string |
* Обязательный параметр
Код 500
Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
{ "code": integer, "details": [ { "@type": string } ], "message": string }
Скопировано
Представление
Поля
code | integer |
details[] | array |
details[]. | string |
message | string |
code | integer |
details[] | array |
details[]. | string |
message | string |
* Обязательный параметр