Перейти к содержанию

Доступ

Авторизация

Все запросы требуют API-ключ и номер проекта для авторизации. API-ключ можно посмотреть в настройках профиля.

Номер проекта можно передавать в URL запроса, например: https://cloud.roistat.com/api/v1/project/access/get-authorized-users?project=12345

API-ключ можно передавать двумя способами:

  • Устанавливая HTTP-заголовок Api-key(рекомендуемый способ):

    Api-key: 1234567890qwerty
    
  • Добавляя параметр key в URL запроса (небезопасный способ):

    https://cloud.roistat.com/api/v1/project/access/get-authorized-users?key=1234567890qwerty&project=12345
    

Получить список авторизованных пользователей и их права доступа к проекту

GET /project/access/get-authorized-users

Воспользуйтесь этим методом, чтобы получить список авторизованных пользователей и их права доступа к проекту.

Строка запроса:

POST https://cloud.roistat.com/api/v1/project/access/get-authorized-users?project=12345

Тело запроса:

Без параметров.

{
    "authorized_users": [
        {
            "email": "example_1@mail.com",
            "name": null,
            "access": "owner"
        },
        {
            "email": "example_2@mail.com",
            "name": null,
            "access": "read"
        }
    ],
    "status": "success"
}

Строка запроса:

Параметр Тип Описание Обязательный
project string Номер проекта да

Тело запроса:

Без параметров.

Параметр Тип Описание Обязательный
authorized_users array[object] нет
email string адрес электронной почты пользователя нет
name null или string имя пользователя, если указано в его профиле нет
access string права доступа к проекту: - owner - владелец; - read - чтение; - write - чтение и запись. нет
status string нет

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

POST /project/access/change

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

Строка запроса:

POST https://cloud.roistat.com/api/v1/project/access/change?project=12345

Тело запроса:

{
    "email": "example@mail.com",
    "access": "read"
}
{
    "status": "success"
}

Строка запроса:

Параметр Тип Описание Обязательный
project string Номер проекта да

Тело запроса:

Параметр Тип Описание Обязательный
email string адрес электронной почты пользователя да
access string новые права доступа: - write - чтение и запись; - read - только чтение; - none - запрет на доступ. да
Параметр Тип Описание Обязательный
status string нет