Добавить доступ пользователю/группе к странице

Добавляет персональный доступ к странице для указанного пользователя или группы.

Позволяет предоставить доступ с одной из ролей:

  • reader — чтение
  • editor — редактирование
  • extra_editor — расширенное редактирование (управление доступами)
  • author — автор (полный доступ)

Request

POST

https://api.wiki.yandex.net/v1/pages/{idx}/access

Path parameters

Name

Description

idx

Type: integer

ID страницы

Body

application/json
{
  "user": {
    "uid": "example",
    "cloud_uid": "example"
  },
  "group": {
    "src": "dir",
    "id": "example"
  },
  "role": "reader",
  "inheritance": "inherited"
}

Name

Description

role
All of 1 type

  • RoleAPI

    Type: RoleAPI

    Роль доступа к странице:

    • reader — чтение
    • editor — редактирование
    • extra_editor — расширенное редактирование (управление доступами)
    • author — автор (полный доступ)

    Enum: reader, editor, extra_editor, author

Роль доступа: reader (чтение), editor (редактирование), extra_editor (расширенное редактирование), author (автор)

Example: reader

group
All of 1 type

  • ComIdentitySchema

    Type: ComIdentitySchema

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

    Example
    {
  "src": "dir",
  "id": "example"
}

Идентификатор группы, которой предоставляется доступ. Укажите либо user, либо group

Example
{
  "src": "dir",
  "id": "example"
}

inheritance
All of 1 type

  • InheritanceAPI

    Type: InheritanceAPI

    Наследование доступа для подстраниц:

    • inherited — доступ наследуется подстраницами
    • not_inherited — доступ не наследуется подстраницами

    Enum: inherited, not_inherited

Наследование доступа для подстраниц: inherited (наследуется), not_inherited (не наследуется)

Example: inherited

user
All of 1 type

  • UserIdentity

    Type: UserIdentity

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

    Example
    {
  "uid": "example",
  "cloud_uid": "example"
}

Идентификатор пользователя, которому предоставляется доступ. Укажите либо user, либо group

Example
{
  "uid": "example",
  "cloud_uid": "example"
}

UserIdentity

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

Name

Description

cloud_uid

Type: string

Идентификатор пользователя в облаке (для внешнего инстанса)

Example: example

uid

Type: string

Идентификатор пользователя в Яндекс (для внутреннего инстанса)

Example: example
Example
{
  "uid": "example",
  "cloud_uid": "example"
}

ComSource

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

  • dir — IAM
  • cloud — Яндекс Облако
  • com — локальная база данных
  • staff — Стафф (внутренний справочник сотрудников)

Type: string

Enum: dir, cloud, com, staff

ComIdentitySchema

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

Name

Description

id

Type: string

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

Example: example

src
All of 1 type

  • ComSource

    Type: ComSource

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

    • dir — IAM
    • cloud — Яндекс Облако
    • com — локальная база данных
    • staff — Стафф (внутренний справочник сотрудников)

    Enum: dir, cloud, com, staff

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

Example: dir
Example
{
  "src": "dir",
  "id": "example"
}

RoleAPI

Роль доступа к странице:

  • reader — чтение
  • editor — редактирование
  • extra_editor — расширенное редактирование (управление доступами)
  • author — автор (полный доступ)

Type: string

Enum: reader, editor, extra_editor, author

InheritanceAPI

Наследование доступа для подстраниц:

  • inherited — доступ наследуется подстраницами
  • not_inherited — доступ не наследуется подстраницами

Type: string

Enum: inherited, not_inherited

Responses

200 OK

OK

Body

application/json
{
  "id": "example",
  "created_at": "2025-01-01T00:00:00Z",
  "user": {
    "id": 0,
    "identity": {
      "uid": "example",
      "cloud_uid": "example"
    },
    "username": "example",
    "display_name": "example",
    "is_dismissed": true,
    "affiliation": "example"
  },
  "group": {
    "id": "example",
    "identity": {
      "src": null,
      "id": "example"
    },
    "name": "example",
    "type": "wiki",
    "metadata": {
      "url": "example",
      "externals_count": 0
    },
    "members_count": 0
  },
  "role": "reader",
  "inheritance": "inherited"
}

Name

Description

id

Type: string

Уникальный идентификатор доступа

Example: example

role
All of 1 type

  • RoleAPI

    Type: RoleAPI

    Роль доступа к странице:

    • reader — чтение
    • editor — редактирование
    • extra_editor — расширенное редактирование (управление доступами)
    • author — автор (полный доступ)

    Enum: reader, editor, extra_editor, author

Роль доступа

Example: reader

created_at

Type: string<date-time>

Дата и время создания доступа

Example: 2025-01-01T00:00:00Z

group
All of 1 type

  • GroupSchema

    Type: GroupSchema

    Информация о группе

    Example
    {
  "id": "example",
  "identity": {
    "src": "dir",
    "id": "example"
  },
  "name": "example",
  "type": "wiki",
  "metadata": {
    "url": "example",
    "externals_count": 0
  },
  "members_count": 0
}

Группа, которой предоставлен доступ (заполняется, если доступ предоставлен группе)

Example
{
  "id": "example",
  "identity": {
    "src": "dir",
    "id": "example"
  },
  "name": "example",
  "type": "wiki",
  "metadata": {
    "url": "example",
    "externals_count": 0
  },
  "members_count": 0
}

inheritance
All of 1 type

  • InheritanceAPI

    Type: InheritanceAPI

    Наследование доступа для подстраниц:

    • inherited — доступ наследуется подстраницами
    • not_inherited — доступ не наследуется подстраницами

    Enum: inherited, not_inherited

Настройка наследования доступа для подстраниц

Example: inherited

user
All of 1 type

  • UserSchema

    Type: UserSchema

    Информация о пользователе

    Example
    {
  "id": 0,
  "identity": {
    "uid": "example",
    "cloud_uid": "example"
  },
  "username": "example",
  "display_name": "example",
  "is_dismissed": true,
  "affiliation": "example"
}

Пользователь, которому предоставлен доступ (заполняется, если доступ предоставлен пользователю)

Example
{
  "id": 0,
  "identity": {
    "uid": "example",
    "cloud_uid": "example"
  },
  "username": "example",
  "display_name": "example",
  "is_dismissed": true,
  "affiliation": "example"
}

UserSchema

Информация о пользователе

Name

Description

affiliation

Type: string

Принадлежность пользователя (например, yandex, external)

Example: example

display_name

Type: string

Отображаемое имя пользователя

Example: example

id

Type: integer

Внутренний идентификатор пользователя

is_dismissed

Type: boolean

Пользователь уволен

username

Type: string

Логин пользователя

Example: example

identity
All of 1 type

  • UserIdentity

    Type: UserIdentity

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

    Example
    {
  "uid": "example",
  "cloud_uid": "example"
}

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

Example
{
  "uid": "example",
  "cloud_uid": "example"
}
Example
{
  "id": 0,
  "identity": {
    "uid": "example",
    "cloud_uid": "example"
  },
  "username": "example",
  "display_name": "example",
  "is_dismissed": true,
  "affiliation": "example"
}

GroupType

Тип группы:

  • wiki — группа Вики
  • service — сервисная группа
  • servicerole — роль сервиса
  • group — обычная группа
  • department — подразделение

Type: string

Enum: wiki, service, servicerole, group, department

IntranetGroupMetadata

Метаданные группы из внутреннего справочника

Name

Description

externals_count

Type: integer

Количество внешних консультантов в группе

url

Type: string

URL группы в справочнике

Example: example
Example
{
  "url": "example",
  "externals_count": 0
}

IamGroupMetadata

Метаданные группы из IAM (Identity and Access Management)

Name

Description

dir_id

Type: string

Идентификатор директории

Example: example
Example
{
  "dir_id": "example"
}

GroupSchema

Информация о группе

Name

Description

identity
All of 1 type

  • ComIdentitySchema

    Type: ComIdentitySchema

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

    Example
    {
  "src": "dir",
  "id": "example"
}

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

Example
{
  "src": "dir",
  "id": "example"
}

name

Type: string

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

Example: example

type
All of 1 type

  • GroupType

    Type: GroupType

    Тип группы:

    • wiki — группа Вики
    • service — сервисная группа
    • servicerole — роль сервиса
    • group — обычная группа
    • department — подразделение

    Enum: wiki, service, servicerole, group, department

Тип группы

Example: wiki

id

Type: string

Идентификатор группы. Для внешнего инстанса — dir_id, для внутреннего — staff_id

Example: example

members_count

Type: integer

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

Default: 0

metadata
Any of 2 types

  • IntranetGroupMetadata

    Type: IntranetGroupMetadata

    Метаданные группы из внутреннего справочника

    Example
    {
  "url": "example",
  "externals_count": 0
}

  • IamGroupMetadata

    Type: IamGroupMetadata

    Метаданные группы из IAM (Identity and Access Management)

    Example
    {
  "dir_id": "example"
}

Дополнительные метаданные группы

Example
{
  "url": "example",
  "externals_count": 0
}
Example
{
  "id": "example",
  "identity": {
    "src": "dir",
    "id": "example"
  },
  "name": "example",
  "type": "wiki",
  "metadata": {
    "url": "example",
    "externals_count": 0
  },
  "members_count": 0
}
Предыдущая
Обзор
Следующая
Удалить все персональные доступы страницы