Создать группу

Создает новую группу. Пользователь, от имени которого выполняется запрос, не включается в состав группы.

Примечание

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

Request

POST

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

Path parameters

Name

Description

orgId*

Type: integer<int64>

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

Body

application/json

{
    "name": "string",
    "description": "string",
    "label": "string",
    "externalId": "string",
    "members": [
        {
            "type": "user",
            "id": "string"
        }
    ],
    "adminIds": [
        "string"
    ]
}

Name	Description
name*	Type: string Название группы.
adminIds	Type: string<uint64>[] Идентификаторы сотрудников организации, котрые являются руководителями группы.
description	Type: string Описание группы.
externalId	Type: string Произвольный внешний идентификатор группы.
label	Type: string Имя почтовой рассылки группы. Например, для адреса `new-group@ваш-домен.ru` имя почтовой рассылки — это `new-group`.
members	Type: v1GroupMember[] Участники группы.

v1GroupMember

Name

Description

Type: string<uint64>

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

type

Type: GroupMemberGroupMemberType

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

Default: user

Enum: user, group, department

GroupMemberGroupMemberType

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

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

Type

Description

GroupMemberGroupMemberType

Default: user

Enum: user, group, department

Responses

200 OK

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

Body

application/json

{
    "id": 0,
    "name": "string",
    "type": "string",
    "description": "string",
    "membersCount": 0,
    "label": "string",
    "email": "string",
    "aliases": [
        "string"
    ],
    "externalId": "string",
    "removed": false,
    "members": [
        {
            "type": "user",
            "id": "string"
        }
    ],
    "adminIds": [
        "string"
    ],
    "authorId": "string",
    "memberOf": [
        0
    ],
    "createdAt": "2022-12-29T18:02:01Z"
}

Name	Description
adminIds	Type: string<uint64>[] Идентификаторы руководетелей группы.
aliases	Type: string[] Алиасы почтовых ящиков группы.
authorId	Type: string<uint64> Идентификатор создателя группы.
createdAt	Type: string<date-time> Дата и время создания группы.
description	Type: string Описание группы.
email	Type: string Адрес почтовой рассылки группы.
externalId	Type: string Произвольный внешний идентификатор группы.
id	Type: integer<int64> Идентификатор группы.
label	Type: string Имя почтовой рассылки группы. Например, для адреса `new-group@ваш-домен.ru` имя почтовой рассылки — это `new-group`.
memberOf	Type: integer<int64>[] Идентификаторы групп, в которые входит эта группа.
members	Type: v1GroupMember[] Участники группы.
membersCount	Type: integer<int64> Количество участников группы.
name	Type: string Название группы.
removed	Type: boolean Признак удаленной группы: `true` — группа удалена; `false` — группа действующая.
type	Type: string Тип группы.

401 Unauthorized

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

Body

application/json

{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name	Description
code	Type: integer<int32> Код ошибки.
details	Type: any[] Дополнительные сведения об ошибке.
message	Type: string Описание ошибки.

403 Forbidden

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

Body

application/json

{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name	Description
code	Type: integer<int32> Код ошибки.
details	Type: any[] Дополнительные сведения об ошибке.
message	Type: string Описание ошибки.

404 Not Found

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

Body

application/json

{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name	Description
code	Type: integer<int32> Код ошибки.
details	Type: any[] Дополнительные сведения об ошибке.
message	Type: string Описание ошибки.

500 Internal Server Error

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

Body

application/json

{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name	Description
code	Type: integer<int32> Код ошибки.
details	Type: any[] Дополнительные сведения об ошибке.
message	Type: string Описание ошибки.

Создать группу

Request

Path parameters

Body

v1GroupMember

GroupMemberGroupMemberType

Responses

200 OK

Body

401 Unauthorized

Body

403 Forbidden

Body

404 Not Found

Body

500 Internal Server Error

Body

Была ли статья полезна?