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

Добавляет участника в группу. Участником группы может быть сотрудник организации, отдельное подразделение или другая группа.

Примечание

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

Request

POST

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

Path parameters

Name

Description

groupId

Type: integer

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

orgId

Type: integer

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

Body

application/json

{
  "type": "user",
  "id": "example"
}

Name

Description

Type: string<uint64>

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

Example: example

type

Type: GroupMemberGroupMemberType

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

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

Default: user

Enum: user, group, department

GroupMemberGroupMemberType

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

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

Type: string

Default: user

Enum: user, group, department

Responses

200 OK

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

Body

application/json

{
  "id": "example",
  "type": "example",
  "added": true
}

Name	Description
added	Type: boolean Признак добавления участника: `true` — добавлен; `false` — не добавлен.
id	Type: string<uint64> Идентификатор участника группы. Example: `example`
type	Type: string Тип участника группы. Example: `example`

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`

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

Изменить список участников группы

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