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

Пароли

API методы для модуля password

Пароли

Получение списка

GET /password/api/password/list

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

curl 'https://{HOST}.platrum.ru/password/api/password/list' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}'

{
    "status": "success",
    "data": [
        {
            "current_user_access": [
                {
                    "can_edit": true,
                    "can_edit_access": true,
                    "can_add_edit_access": true,
                    "available_user_ids": [
                        "some_string",
                        "some_string"
                    ]
                }
            ],
            "admin_user_ids": [
                "some_string",
                "some_string"
            ],
            "matched_auth_data_password_ids": [
                123,
                123
            ],
            "id": 123,
            "name": "some_string",
            "url": "some_string",
            "login": "some_string",
            "password": "some_string",
            "description": "some_string",
            "author_id": "some_string",
            "last_editor_id": "some_string",
            "category_id": 123,
            "access": "map[password.access]",
            "password_update_date": "2019-01-01 21:00:15",
            "creation_date": "2019-01-01 21:00:15",
            "modification_date": "2019-01-01 21:00:15",
            "is_archived": true,
            "is_offline": true
        },
        {
            "current_user_access": [
                {
                    "can_edit": true,
                    "can_edit_access": true,
                    "can_add_edit_access": true,
                    "available_user_ids": [
                        "some_string",
                        "some_string"
                    ]
                }
            ],
            "admin_user_ids": [
                "some_string",
                "some_string"
            ],
            "matched_auth_data_password_ids": [
                123,
                123
            ],
            "id": 123,
            "name": "some_string",
            "url": "some_string",
            "login": "some_string",
            "password": "some_string",
            "description": "some_string",
            "author_id": "some_string",
            "last_editor_id": "some_string",
            "category_id": 123,
            "access": "map[password.access]",
            "password_update_date": "2019-01-01 21:00:15",
            "creation_date": "2019-01-01 21:00:15",
            "modification_date": "2019-01-01 21:00:15",
            "is_archived": true,
            "is_offline": true
        }
    ]
}

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

Параметр Описание Тип Значения
current_user_access Доступ текущего пользователя user_access -
admin_user_ids Id пользователей с правами администратора array[string] -
matched_auth_data_password_ids Id паролей с идентичными данными array[int] -
id ID int -
name Название string -
url Ссылка на страницу string -
login Логин string -
password Пароль string -
description Описание string -
author_id Id автора string -
last_editor_id Id последнего редактора string -
category_id Id категории int -
access Доступы map[password.access] -
password_update_date Дата обновления пароля date -
creation_date Дата создания date -
modification_date Дата обновления date -
is_archived Статус архивации bool -
is_offline Является ли паролем оффлайн системы bool -

Создание и обновление

POST /password/api/password/save

Метод может быть использован как для сохранения изменений в существующем пароле, так и для создания нового. Если передать пустой id, то будет создан новый пароль.

curl 'https://{HOST}.platrum.ru/password/api/password/save' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123,"name":"some_string","url":"some_string","login":"some_string","password":"some_string","description":"some_string","category_id":123,"access":[{"can_edit":true,"can_edit_access":true,"can_add_edit_access":true,"available_user_ids":["some_string","some_string"]}],"is_offline":true}'

{
    "status": "success",
    "data": {
        "current_user_access": [
            {
                "can_edit": true,
                "can_edit_access": true,
                "can_add_edit_access": true,
                "available_user_ids": [
                    "some_string",
                    "some_string"
                ]
            }
        ],
        "admin_user_ids": [
            "some_string",
            "some_string"
        ],
        "matched_auth_data_password_ids": [
            123,
            123
        ],
        "id": 123,
        "name": "some_string",
        "url": "some_string",
        "login": "some_string",
        "password": "some_string",
        "description": "some_string",
        "author_id": "some_string",
        "last_editor_id": "some_string",
        "category_id": 123,
        "access": "map[password.access]",
        "password_update_date": "2019-01-01 21:00:15",
        "creation_date": "2019-01-01 21:00:15",
        "modification_date": "2019-01-01 21:00:15",
        "is_archived": true,
        "is_offline": true
    }
}
Параметр Описание Тип Значения
id Id пароля int -
name Назание пароля string -
url Ссылка на страницу string -
login* Логин string -
password* Пароль string -
description Описание string -
category_id* Id категории int -
access Доступы user_access -
is_offline Является ли паролем оффлайн системы bool -
Параметр Описание Тип Значения
current_user_access Доступ текущего пользователя user_access -
admin_user_ids Id пользователей с правами администратора array[string] -
matched_auth_data_password_ids Id паролей с идентичными данными array[int] -
id ID int -
name Название string -
url Ссылка на страницу string -
login Логин string -
password Пароль string -
description Описание string -
author_id Id автора string -
last_editor_id Id последнего редактора string -
category_id Id категории int -
access Доступы map[password.access] -
password_update_date Дата обновления пароля date -
creation_date Дата создания date -
modification_date Дата обновления date -
is_archived Статус архивации bool -
is_offline Является ли паролем оффлайн системы bool -

Удаление

POST /password/api/password/remove

Метод позволяет удалить пароль.

curl 'https://{HOST}.platrum.ru/password/api/password/remove' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123}'

{
    "status": "success",
    "data": true
}
Параметр Описание Тип Значения
id* Id удаляемого пароля int -

bool

Категории

Получение списка

GET /password/api/category/list

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

curl 'https://{HOST}.platrum.ru/password/api/category/list' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}'

{
    "status": "success",
    "data": [
        {
            "current_user_access": [
                {
                    "can_edit": true,
                    "can_edit_access": true,
                    "can_add_edit_access": true,
                    "available_user_ids": [
                        "some_string",
                        "some_string"
                    ]
                }
            ],
            "admin_user_ids": [
                "some_string",
                "some_string"
            ],
            "id": 123,
            "type": "some_string",
            "name": "some_string",
            "author_id": "some_string",
            "last_editor_id": "some_string",
            "encrypted_sample_password": "some_string",
            "order": 123,
            "access": "map[password.access]",
            "creation_date": "2019-01-01 21:00:15",
            "modification_date": "2019-01-01 21:00:15",
            "is_archived": true
        },
        {
            "current_user_access": [
                {
                    "can_edit": true,
                    "can_edit_access": true,
                    "can_add_edit_access": true,
                    "available_user_ids": [
                        "some_string",
                        "some_string"
                    ]
                }
            ],
            "admin_user_ids": [
                "some_string",
                "some_string"
            ],
            "id": 123,
            "type": "some_string",
            "name": "some_string",
            "author_id": "some_string",
            "last_editor_id": "some_string",
            "encrypted_sample_password": "some_string",
            "order": 123,
            "access": "map[password.access]",
            "creation_date": "2019-01-01 21:00:15",
            "modification_date": "2019-01-01 21:00:15",
            "is_archived": true
        }
    ]
}

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

Параметр Описание Тип Значения
current_user_access Доступ текущего пользователя user_access -
admin_user_ids Id пользователей с правами администратора array[string] -
id ID int -
type Тип string private/common
name Название string -
author_id Id автора string -
last_editor_id Id последнего редактора string -
encrypted_sample_password Мастер пароль string -
order Значение сортировки int -
access Доступы map[password.access] -
creation_date Дата создания date -
modification_date Дата обновления date -
is_archived Статус архивации bool -

Создание и обновление

POST /password/api/category/save

Метод может быть использован как для сохранения изменений в существующей категории, так и для создания новой. Если передать пустой id, то будет создана новая категория.

curl 'https://{HOST}.platrum.ru/password/api/category/save' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123,"type":"some_string","encrypted_sample_password":"some_string","name":"some_string","access":[{"can_edit":true,"can_edit_access":true,"can_add_edit_access":true,"available_user_ids":["some_string","some_string"]}]}'

{
    "status": "success",
    "data": {
        "current_user_access": [
            {
                "can_edit": true,
                "can_edit_access": true,
                "can_add_edit_access": true,
                "available_user_ids": [
                    "some_string",
                    "some_string"
                ]
            }
        ],
        "admin_user_ids": [
            "some_string",
            "some_string"
        ],
        "id": 123,
        "type": "some_string",
        "name": "some_string",
        "author_id": "some_string",
        "last_editor_id": "some_string",
        "encrypted_sample_password": "some_string",
        "order": 123,
        "access": "map[password.access]",
        "creation_date": "2019-01-01 21:00:15",
        "modification_date": "2019-01-01 21:00:15",
        "is_archived": true
    }
}
Параметр Описание Тип Значения
id Id категории int -
type* Тип категории string private/common
encrypted_sample_password Мастер пароль string -
name* Название категории string -
access Доступы user_access -
Параметр Описание Тип Значения
current_user_access Доступ текущего пользователя user_access -
admin_user_ids Id пользователей с правами администратора array[string] -
id ID int -
type Тип string private/common
name Название string -
author_id Id автора string -
last_editor_id Id последнего редактора string -
encrypted_sample_password Мастер пароль string -
order Значение сортировки int -
access Доступы map[password.access] -
creation_date Дата создания date -
modification_date Дата обновления date -
is_archived Статус архивации bool -

Удаление

POST /password/api/category/remove

Метод позволяет удалить категорию.

curl 'https://{HOST}.platrum.ru/password/api/category/remove' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123}'

{
    "status": "success",
    "data": true
}
Параметр Описание Тип Значения
id* Id удаляемой категории int -

bool