Пользователи

Права пользователя делятся на следующие категории:

  1. Создание
  2. Просмотр
  3. Редактирование
  4. Удаление
  5. Экспорт

Общие обозначения прав пользователей

Маркировка Параметр Описание
A access Доступен весь функционал данной категории
G group Функционал доступен, если ответственный состоит в группе пользователя
M main Функционал доступен, если ответственным является текущий пользователь
D denied Функционал недоступен

Приоритет расчета прав идет в следующем порядке (на примере сделок):

  1. Сначала применяются общие права
  2. Затем применяются права на статусы (ограничивают/расширяют права)
  3. Затем права на просмотр могут быть приоткрыты, если пользователь является подписчиком в чате сделки

Права на создание и права на статусы могут иметь только значения: A, D
Статусы неразобранного не имеют прав на экспорт
Права для покупателей наследуются от прав на сделки

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

Список пользователей

Метод позволяет получить список имеющихся в аккаунте пользователей.

Метод доступен только для администраторов аккаунта.

URL метода

GET /api/v4/users

Возможные query параметры запроса

Параметр Описание
with Если в параметре with указать значения: role, group, то в ответ придет доп. информация по пользователя.
role – Добавляет в ответ роль к которой принадлежит пользователь
group – Добавляет в ответ группу к которой принадлежит пользователь

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


GET https://example.amocrm.ru/api/v4/users?with=role,group

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


{
    "_total_items": 2,
    "_page": 1,
    "_page_count": 1,
    "_links": {
        "self": {
            "href": "https://example.amocrm.ru/api/v4/users/?with=role%2Cgroup"
        }
    },
    "_embedded": {
        "users": [
            {
                "id": 123123,
                "name": "Пользователь для примера 2",
                "email": "example2@mail.com",
                "lang": "en",
                "rights": {
                    "leads": {
                        "view": "A",
                        "edit": "A",
                        "add": "A",
                        "delete": "A",
                        "export": "A"
                    },
                    "contacts": {
                        "view": "A",
                        "edit": "A",
                        "add": "A",
                        "delete": "A",
                        "export": "A"
                    },
                    "companies": {
                        "view": "A",
                        "edit": "A",
                        "add": "A",
                        "delete": "A",
                        "export": "A"
                    },
                    "tasks": {
                        "edit": "A",
                        "delete": "A"
                    },
                    "mail_access": false,
                    "catalog_access": false,
                    "status_rights": [
                        {
                            "entity_type": "leads",
                            "pipeline_id": 2194576,
                            "status_id": 30846277,
                            "rights": {
                                "view": "A",
                                "edit": "A",
                                "delete": "A"
                            }
                        },
                        {
                            "entity_type": "leads",
                            "pipeline_id": 2212201,
                            "status_id": 30965377,
                            "rights": {
                                "view": "A",
                                "edit": "A",
                                "delete": "A"
                            }
                        }
                    ],
                    "is_admin": false,
                    "is_free": false,
                    "is_active": true,
                    "group_id": null,
                    "role_id": null
                },
                "_links": {
                    "self": {
                        "href": "https://example.amocrm.ru/api/v4/users/123123/"
                    }
                },
                "_embedded": {
                   "roles": [
                        {
                            "id": 3141,
                            "name": "Менеджер",
                            "_links": {
                                "self": {
                                    "href": "https://example.amocrm.ru/api/v4/roles/3141"
                                }
                            }
                        }
                    ],
                    "groups": [
                        {
                            "id": 267688,
                            "name": "Менеджеры"
                        }
                    ]
                }
            },
            {
                "id": 321321,
                "name": "Пользователь для примера 2",
                "email": "example2@mail.com",
                "lang": "ru",
                "rights": {
                    "leads": {
                        "view": "A",
                        "edit": "A",
                        "add": "G",
                        "delete": "D",
                        "export": "M"
                    },
                    "contacts": {
                        "view": "A",
                        "edit": "A",
                        "add": "G",
                        "delete": "M",
                        "export": "D"
                    },
                    "companies": {
                        "view": "A",
                        "edit": "G",
                        "add": "G",
                        "delete": "D",
                        "export": "D"
                    },
                    "tasks": {
                        "edit": "A",
                        "delete": "A"
                    },
                    "mail_access": true,
                    "catalog_access": true,
                    "status_rights": null,
                    "is_admin": true,
                    "is_free": false,
                    "is_active": true,
                    "group_id": null,
                    "role_id": null
                },
                "_links": {
                    "self": {
                        "href": "https://example.amocrm.ru/api/v4/users/321321"
                    }
                },
                "_embedded": {
                    "roles": [],
                    "groups": []
                }
            }
        ]
    }
}

Добавление пользователей

URL метода

POST /api/v4/users

Общие ограничения:

  1. Для работы с API создания пользователей, в аккаунте должен быть установлен действующий или триальный тариф
  2. За один запрос нельзя добавить больше 10 пользователей
  3. API добавления пользователей становится недоступным как только аккаунт превышает лимит в 100 пользователей (активные + неактивные + бесплатные)
  4. Нельзя создавать пользователя с привилегиями администратора аккаунта
  5. Если превышен лимит пользователей по тарифу, то новые пользователи будут добавляться неактивными с флагом is_active: false

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

Ключ Тип Описание Особенности
name string Полное имя пользователя.
Поле не должно:
содержать спец символов кроме . @ – _ ,
состоять из одних пробелов,
содержать ссылок, иметь длину не более 50 символов
Обязательно при создании нового пользователя
email string Email пользователя Обязательное поле, валидный email-адрес
password string Пароль пользователя, должно состоять минимум из 6 символов и иметь хотя бы 1 цифру, маленькую и заглавную букву Обязательно при создании нового пользователя
lang string Язык пользователя: en, ru, es Необязательное поле, по умолчанию язык аккаунта
rights object Права пользователя в текущем аккаунте Необязательное поле, по умолчанию все запрещено

Поле rights должно соответствовать следующим требованиям:

Ключ Тип Описание Особенности
leads object Общие права на сделки Обязательное поле, если нет role_id и не выставлен флаг is_free
tasks object Общие права на задачи Обязательное поле, если нет role_id и не выставлен флаг is_free
contacts object Общие права на контакты Обязательное поле, если нет role_id и не выставлен флаг is_free
companies object Общие права на сделки Обязательное поле, если нет role_id и не выставлен флаг is_free
status_rights array|null Права на статусы Необязательное поле, по умолчанию: null
mail_access boolean Доступ к почте Необязательное поле, по умолчанию: false
catalog_access boolean Доступ к спискам Необязательное поле, по умолчанию: false
role_id int|null Идентификатор роли Необязательное поле, по умолчанию: null
is_free boolean Бесплатный пользователь Необязательное поле, по умолчанию: false
group_id int|null Идентификатор группы Необязательное поле, по умолчанию: null
  1. Если передано поле role_id,то значения полей leads, tasks, contacts, companies, status_rights, mail_access, catalog_access будут проигнорированы
  2. Если передано поле is_free, то значения полей leads, tasks, contacts, companies, status_rights, mail_access, catalog_access, group_id, role_id будут проигнорированы
  3. Если group_id: null – группа по умолчанию “Отдел продаж”

  4. “Администратор” и “Бесплатные пользователи” не являются ролями, для обозначения заведены отдельные флаги is_free и is_admin
  5. Если передать поле status_rights со значением null, будут выставлены права на статусы неразобранного без доступов

Поля leads, contacts, companies в объекте rights должны учитывать зависимость прав и соответствовать следующим требованиям:

Ключ Тип Описание Особенности
add string Права на добавление сущностей Обязательное поле, возможные значения: A, D
edit string Права на редактирование сущностей Обязательное поле, возможные значения.
view string Права на просмотр сущностей Обязательное поле, возможные значения.
delete string Права на удаление сущностей Обязательное поле, возможные значения.
export string Права на экспорт сущностей Обязательное поле, возможные значения.

Поле tasks должно соответствовать следующим требованиям:

Ключ Тип Описание Особенности
edit string Права на редактирование сущностей Обязательное поле, возможные значения.
delete string Права на удаление сущностей Обязательное поле, возможные значения.

Каждый объект массива status_rights должен соответствовать следующим требованиям:

Ключ Тип Описание Особенности
entity_type string К какому типу сущности относятся права на статусы Обязательное поле, пока что поддерживается только значение leads)
pipeline_id int Идентификатор воронки Обязательное поле для сделок (entity_type: leads)
status_id int Идентификатор статуса Обязательное поле для сделок (entity_type: leads)
rights array|null Права для данного статуса Обязательное поле

Каждый объект rights внутри status_rights должен соответствовать следующим требованиям:

Ключ Тип Описание Особенности
edit string Права на редактирование сущностей Обязательное поле, возможные значения: A, D
view string Права на просмотр сущностей Обязательное поле, возможные значения: A, D
delete string Права на удаление сущностей Обязательное поле, возможные значения: A, D
export string Права на экспорт сущностей Обязательное поле, возможные значения: A, D

Для статусов неразобранного поле export передавать не нужно
Значения полей объекта rights должны учитывать зависимость прав

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


POST https://example.amocrm.ru/api/v4/users
Content-Type: application/json

[
    {
        "name": "Пользователь для примера",
        "email": "example@team.amocrm.com",
        "lang": "en",
        "password": "Af13cbgrwzbTff",
        "rights": {
            "leads": {
                "view": "A",
                "edit": "A",
                "add": "A",
                "delete": "A",
                "export": "D"
            },
            "contacts": {
                "view": "A",
                "edit": "A",
                "add": "A",
                "delete": "A",
                "export": "D"
            },
            "companies": {
                "view": "A",
                "edit": "A",
                "add": "A",
                "delete": "A",
                "export": "D"
            },
            "tasks": {
                "edit": "A",
                "delete": "A"
            },
            "mail_access": false,
            "catalog_access": false,
            "status_rights": [
                {
                    "entity_type": "leads",
                    "pipeline_id": 2194576,
                    "status_id": 30846280,
                    "rights": {
                        "view": "D",
                        "edit": "D",
                        "delete": "D",
                        "export": "D"
                    }
                },
                {
                    "entity_type": "leads",
                    "pipeline_id": 2194576,
                    "status_id": 30846280,
                    "rights": {
                        "view": "D",
                        "edit": "D",
                        "delete": "D",
                        "export": "D"
                    }
                }
            ],
            "is_free": false
        },
        "request_id": 1
    }
]

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


Response code: 201 (Created)

{
    "_total_items": 1,
    "_embedded": {
        "users": [
            {
                "id": 123123,
                "name": "Пользователь для примера",
                "email": "example@team.amocrm.com",
                "lang": "en",
                "rights": {
                    "leads": {
                        "view": "A",
                        "edit": "A",
                        "add": "A",
                        "delete": "A",
                        "export": "D"
                    },
                    "contacts": {
                        "view": "A",
                        "edit": "A",
                        "add": "A",
                        "delete": "A",
                        "export": "D"
                    },
                    "companies": {
                        "view": "A",
                        "edit": "A",
                        "add": "A",
                        "delete": "A",
                        "export": "D"
                    },
                    "tasks": {
                        "edit": "A",
                        "delete": "A"
                    },
                    "mail_access": false,
                    "catalog_access": false,
                    "status_rights": [
                        {
                            "entity_type": "leads",
                            "pipeline_id": 2194576,
                            "status_id": 30846280,
                            "rights": {
                                "view": "D",
                                "edit": "D",
                                "delete": "D",
                                "export": "D"
                            }
                        },
                        {
                            "entity_type": "leads",
                            "pipeline_id": 2194576,
                            "status_id": 30846277,
                            "rights": {
                                "view": "D",
                                "edit": "D",
                                "delete": "D"
                            }
                        },
                        {
                            "entity_type": "leads",
                            "pipeline_id": 2212201,
                            "status_id": 30965377,
                            "rights": {
                                "view": "D",
                                "edit": "D",
                                "delete": "D"
                            }
                        },
                        {
                            "entity_type": "leads",
                            "pipeline_id": 2212207,
                            "status_id": 30965404,
                            "rights": {
                                "view": "D",
                                "edit": "D",
                                "delete": "D"
                            }
                        },
                        {
                            "entity_type": "leads",
                            "pipeline_id": 2297686,
                            "status_id": 31561504,
                            "rights": {
                                "view": "D",
                                "edit": "D",
                                "delete": "D"
                            }
                        },
                        {
                            "entity_type": "leads",
                            "pipeline_id": 3103690,
                            "status_id": 31875574,
                            "rights": {
                                "view": "D",
                                "edit": "D",
                                "delete": "D"
                            }
                        },
                        {
                            "entity_type": "leads",
                            "pipeline_id": 3118984,
                            "status_id": 31981315,
                            "rights": {
                                "view": "D",
                                "edit": "D",
                                "delete": "D"
                            }
                        },
                        {
                            "entity_type": "leads",
                            "pipeline_id": 3119002,
                            "status_id": 31981402,
                            "rights": {
                                "view": "D",
                                "edit": "D",
                                "delete": "D"
                            }
                        },
                        {
                            "entity_type": "leads",
                            "pipeline_id": 3129277,
                            "status_id": 32052118,
                            "rights": {
                                "view": "D",
                                "edit": "D",
                                "delete": "D"
                            }
                        },
                        {
                            "entity_type": "leads",
                            "pipeline_id": 3132832,
                            "status_id": 32076970,
                            "rights": {
                                "view": "D",
                                "edit": "D",
                                "delete": "D"
                            }
                        },
                        {
                            "entity_type": "leads",
                            "pipeline_id": 3142915,
                            "status_id": 32145802,
                            "rights": {
                                "view": "D",
                                "edit": "D",
                                "delete": "D"
                            }
                        },
                        {
                            "entity_type": "leads",
                            "pipeline_id": 3147661,
                            "status_id": 32179363,
                            "rights": {
                                "view": "D",
                                "edit": "D",
                                "delete": "D"
                            }
                        },
                        {
                            "entity_type": "leads",
                            "pipeline_id": 3150025,
                            "status_id": 32196472,
                            "rights": {
                                "view": "D",
                                "edit": "D",
                                "delete": "D"
                            }
                        },
                        {
                            "entity_type": "leads",
                            "pipeline_id": 3153787,
                            "status_id": 32222509,
                            "rights": {
                                "view": "D",
                                "edit": "D",
                                "delete": "D"
                            }
                        },
                        {
                            "entity_type": "leads",
                            "pipeline_id": 3156175,
                            "status_id": 32239225,
                            "rights": {
                                "view": "D",
                                "edit": "D",
                                "delete": "D"
                            }
                        },
                        {
                            "entity_type": "leads",
                            "pipeline_id": 3190612,
                            "status_id": 32481271,
                            "rights": {
                                "view": "D",
                                "edit": "D",
                                "delete": "D"
                            }
                        }
                    ],
                    "is_admin": false,
                    "is_free": false,
                    "is_active": true,
                    "group_id": null,
                    "role_id": null
                },
                "request_id": "1",
                "_links": {
                    "self": {
                        "href": "https://example.amocrm.ru/api/v4/users/123123/"
                    }
                }
            }
        ]
    }
}

Смотрите также

КОДЫ ОШИБОК API