[API] Получение списка пользователей с доступом к проекту/публикации

Возвращает список пользователей, которые имеют доступ к проекту/публикации.

GET projects/{externalId}/users?types={types}

Авторизация

Этот запрос требует базовой авторизации.

Параметры запроса

Параметры пути

externalId	string	Идентификатор проекта или публикации.

Параметры запроса

types	array of strings	[опционально] Тип(ы) пользователей – PowerReader или Contributor.

Примеры

Пример запроса

Скопировать код

Bash (оболочка Unix)

curl --location -g --request GET 'https://{portal-url}/api/v1/projects/my-manual-publication/users?types=Contributor%2CPowerReader'

Пример тела ответа

Скопировать код

Bash (оболочка Unix)

[
    {
        "userInfo": {
            "about": "",
            "authorUiFourLetterCode": "ru-RU",
            "avatarImageUrl": null,
            "cultureInfoId": "ru-RU",
            "email": "admin@email.com",
            "firstName": "",
            "forcedRedirectUrls": [],
            "isAutoDetectCultureInfo": true,
            "isAutoDetectTimeZone": true,
            "isEnableHomeEditorAdvancedCss": false,
            "isFirstTrialUser": false,
            "lastActivityDate": "/Date(1734525940030+0000)/",
            "lastName": "",
            "middleName": "",
            "timeZoneId": "Jordan Standard Time"
        },
        "userName": "admin",
        "userRole": "Administrator",
        "userType": "Contributor",
        "isEnabled": true
    },
    {
        "userInfo": {
            "about": "",
            "authorUiFourLetterCode": "ru-RU",
            "avatarImageUrl": null,
            "cultureInfoId": "ru-RU",
            "email": "power-reader@email.com",
            "firstName": "",
            "forcedRedirectUrls": [],
            "isAutoDetectCultureInfo": false,
            "isAutoDetectTimeZone": true,
            "isEnableHomeEditorAdvancedCss": false,
            "isFirstTrialUser": false,
            "lastActivityDate": null,
            "lastName": "",
            "middleName": "",
            "timeZoneId": "UTC"
        },
        "userName": "power-reader",
        "userRole": null,
        "userType": "PowerReader",
        "isEnabled": true
    }
]

Поля ответа

userInfo	Объект, содержащий основную информацию о профиле.
about	Информация, указанная пользователем в окне Информация.
avatarImageUrl	URL-адрес изображения, используемого в качестве аватара.
cultureInfoId	Четырехбуквенный языковой код пользователя.
email	Электронная почта пользователя.
firstName	Имя пользователя.
isAutoDetectCultureInfo	Определяет, выбирается ли язык автоматически. Условие false (ложно), если язык задается пользователем.
isAutoDetectTimeZone	Определяет, установлен ли режим автоматического определения часового пояса.
lastActivityDate	Временная метка ISO 8601, отражающая дату последней активности пользователя. Часовой пояс GMT.
lastName	Фамилия пользователя.
middleName	Отчество пользователя.
timeZoneId	Идентификатор часового пояса, указанного пользователем.
userName	Логин пользователя.
userType	Тип пользователя: Авторизованный читатель (PowerReader) или Автор (Contributor)
userRole	Разделенный запятыми список групп доступа, к которым относится авторизованный читатель.
isEnabled	Определяет, активна ли учетная запись или нет.