Удалить всех участников из группы

Удаляет из группы всех участников.

Примечание

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

Request

DELETE

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

Path parameters

Name

Description

groupId*

Type: integer<int64>

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

orgId*

Type: integer<int64>

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

Responses

200 OK

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

Body

application/json
{
    "departments": [
        {
            "id": 0,
            "name": "string",
            "membersCount": 0
        }
    ],
    "groups": [
        {
            "id": 0,
            "name": "string",
            "membersCount": 0
        }
    ],
    "users": [
        {
            "id": "string",
            "nickname": "string",
            "departmentId": 0,
            "email": "string",
            "name": {
                "first": "string",
                "last": "string",
                "middle": "string"
            },
            "gender": "string",
            "position": "string",
            "avatarId": "string"
        }
    ]
}

Name

Description

departments

Type: v1ShortDepartment[]

Подразделения.
Краткая информация о подразделении.

groups

Type: v1ShortGroup[]

Группы.
Краткая информация о группе.

users

Type: v1ShortUser[]

Сотрудники.
Краткая информация о сотруднике.

v1ShortDepartment

Краткая информация о подразделении.

Name

Description

id

Type: integer<int64>

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

membersCount

Type: integer<int64>

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

name

Type: string

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

v1ShortGroup

Краткая информация о группе.

Name

Description

id

Type: integer<int64>

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

membersCount

Type: integer<int64>

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

name

Type: string

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

v1ShortUser

Краткая информация о сотруднике.

Name

Description

avatarId

Type: string

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

departmentId

Type: integer<int64>

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

email

Type: string

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

gender

Type: string

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

id

Type: string<uint64>

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

name

Type: v1UserName

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

nickname

Type: string

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

position

Type: string

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

v1UserName

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

Name

Description

first

Type: string

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

last

Type: string

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

middle

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

Описание ошибки.