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

Удаляет из группы участников (сотрудников организации, отдельные подразделения, внешние контакты или вложенные группы) по их идентификаторам.

Примечание

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

Request

PATCH

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

Path parameters

Name

Description

groupId

Type: integer

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

orgId

Type: integer

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

Body

application/json

{
  "userIds": [
    "example"
  ],
  "departmentIds": [
    0
  ],
  "groupIds": [
    0
  ],
  "externalContactIds": [
    "example"
  ],
  "sharedMailboxIds": [
    "example"
  ]
}

Name	Description
departmentIds	Type: integer[] Идентификаторы подразделений. Example `[ 0 ]`
externalContactIds	Type: string[] Идентификаторы внешних контактов. Example `[ "example" ]`
groupIds	Type: integer[] Идентификаторы групп. Example `[ 0 ]`
sharedMailboxIds	Type: string<uint64>[] Идентификаторы общих ящиков. Example `[ "example" ]`
userIds	Type: string<uint64>[] Идентификаторы сотрудников. Example `[ "example" ]`

Responses

200 OK

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

Body

application/json

{}

Name

Description

400 Bad Request

Некорректный запрос.

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

protobufAny

Name

Description

@type

Type: string

Example: example

[additional]

Type: unknown

Example: null

Example

{
  "@type": "example"
}

401 Unauthorized

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

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

403 Forbidden

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

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

404 Not Found

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

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

500 Internal Server Error

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

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

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

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

Обзор