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

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

Создаёт группу доступа.

Требуется право Изменение прав доступа авторов для групп доступа рецензентов или Изменение прав доступа авторизованных читателей для групп доступа читателей. Какие роли ими обладают, см. в Матрице ролей и прав доступа.

Имя группы не должно совпадать с названием роли портала, например Writer, или с именем существующей группы доступа — в любом регистре.

Если в запросе указаны несуществующие проекты, публикации или пользователи, запрос завершается с кодом 404 со списком всех таких объектов. Если они существуют, но не подходят типу группы, запрос завершается с кодом 400.

Body
application/json
name
string
max:
256
required

Имя группы. Не должно содержать запятые и точки с запятой. Не должно совпадать с названием роли портала, например Writer, или с именем существующей группы доступа — в любом регистре. Пробелы в начале и в конце имени удаляются.

projectAccess
object
type
string enum
required

Тип группы. Нельзя изменить после создания группы. Регистр не учитывается.

  • PowerReader
  • Reviewer
userNames
array string[]

Логины участников группы. Если не указано, группа создаётся без участников.

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

Responses
POST/access-groups

{
  "name": "partners",
  "projectAccess": {
    "projectIds": [
      "user-guide-v5",
      "api-reference"
    ],
    "type": "Selected"
  },
  "type": "PowerReader",
  "userCount": 2
}