Изменить группу доступа

Изменить группу доступа

Изменяет параметры группы доступа: имя, доступ к проектам и публикациям, состав участников. Обновляются только поля, перечисленные в updatedFields.

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

projectAccess и userNames заменяют текущие значения целиком. Пустой список userNames удаляет из группы всех участников. Чтобы добавить или удалить отдельных участников, используйте POST или DELETE /access-groups/{groupName}/users.

Переименование в имя, которое отличается от текущего только регистром, ничего не меняет.

Path Parameters
  • groupName
    string
    required

    Имя группы доступа. Регистр не учитывается.

    Имя нужно передавать в URL-кодировании. Косую черту (/) и обратную косую черту (\) кодируйте дважды — как %252F и %255C: с одинарным кодированием (%2F, %5C) запрос завершается ошибкой.

    При создании группы заголовок Location уже содержит закодированное имя — его можно подставлять как есть.

Body
application/json
name
string
max:
256

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

projectAccess
object
updatedFields
string
required

Список изменяемых полей через запятую: name, projectAccess, userNames.

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

Если список пуст, ничего не изменяется и тело ответа пустое.

userNames
array string[]

Новый состав группы. Список заменяет текущий целиком, поэтому пустой список удаляет всех участников.

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

Responses
PATCH/access-groups/{groupName}


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

OK