Просмотреть параметры группы

Возвращает информацию об одной группе.

Примечание

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

Request

GET

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

Path parameters

Name

Description

groupId

Type: integer

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

orgId

Type: integer

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

Responses

200 OK

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

Body

application/json

{
  "id": 0,
  "name": "example",
  "type": "example",
  "description": "example",
  "membersCount": 0,
  "label": "example",
  "email": "example",
  "emailId": "example",
  "aliases": [
    "example"
  ],
  "externalId": "example",
  "removed": true,
  "members": [
    {
      "type": "user",
      "id": "example"
    }
  ],
  "memberOf": [
    0
  ],
  "createdAt": "2025-01-01T00:00:00Z"
}

Name	Description
aliases	Type: string[] Алиасы почтовых ящиков группы. Example `[ "example" ]`
createdAt	Type: string<date-time> Дата и время создания группы. Example: `2025-01-01T00:00:00Z`
description	Type: string Описание группы. Example: `example`
email	Type: string Адрес почтовой рассылки группы. Example: `example`
emailId	Type: string<uint64> Идентификатор почтовой рассылки группы. Example: `example`
externalId	Type: string Произвольный внешний идентификатор группы. Example: `example`
id	Type: integer Идентификатор группы.
label	Type: string Имя почтовой рассылки группы. Например, для адреса `new-group@ваш-домен.ru` имя почтовой рассылки — это `new-group`. Example: `example`
memberOf	Type: integer[] Идентификаторы групп, в которые входит эта группа. Example `[ 0 ]`
members	Type: v1GroupMember[] Участники группы. Example `[ { "type": "user", "id": "example" } ]`
membersCount	Type: integer Количество участников группы.
name	Type: string Название группы. Example: `example`
removed	Type: boolean Признак удаленной группы: `true` — группа удалена; `false` — группа действующая.
type	Type: string Тип группы. Возможные значения: `generic` — стандартная группа, созданная одним из сотрудников организации. Пользователи могут изменять параметры такой группы и ее состав. `organization_admin` — Группа администраторов организации. Неизменяемая техническая группа. `robots` — Группа роботов. Неизменяемая техническая группа. `organization_deputy_admin` — Группа менеджеров организации. Неизменяемая техническая группа. Example: `example`

GroupMemberGroupMemberType

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

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

Type: string

Default: user

Enum: user, group, department

v1GroupMember

Name

Description

Type: string<uint64>

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

Example: example

type

Type: GroupMemberGroupMemberType

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

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

Default: user

Enum: user, group, department

Example

{
  "type": "user",
  "id": "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`

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

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

Удалить группу