Методы для Администратора

Данные методы работают только при наличии прав администратора.

Добавление SSH ключа пользователю

POST /admin/user/{userAlias}/key/create

Запрос добавляет SSH ключ пользователю

Переменная пути запроса Тип Описание
userAlias String Псевдоним пользователя

Request

Передаваемый параметр Тип Описание
publicKey String ssh ключ пользователя
title String Название для ssh ключа пользователя
expiresAt String Дата окончания действия ключа в формате ISO

Поддерживаемый формат - JSON

Структура тела POST-запроса

        {
            "publicKey" : "ssh-ed25519 AAAAC3NzaC1lZFHNRPTE5AAAAIDkxja/2VmTEsJDTtf3bI4XYDpb58fvKfSjy7/u8EZeI your_email@gitflic.ru",
            "title": "Название ключа",
            "expiresAt" : "2020-10-10T10-10-10Z"
        }

Responses

STATUS 200 - Успешное добавление SSH ключа:

Пример ответа 
    
        {
            uuid:"089cdbe3-aaaa-aaaa-aaaa-b0edde8eda6d"
            publicKey:"ssh-ed25519 AAAAC3NzaC1lZFHNRPTE5AAAAIDkxja/2VmTEsJDTtf3bI4XYDpb58fvKfSjy7/u8EZeI your_email@gitflic.ru"
            title:"Название ключа"
            expiresAt: "2020-10-10T10-10-10Z"
            userUuid:"f1a94466-aaaa-aaaa-aaaa-744ec3bbd60c"
        }


STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

STATUS 422 - Данный ключ уже используется.

Удаление SSH ключа пользователя

DELETE admin/user/{userAlias}/key/delete/{keyUuid}

Запрос удаляет SSH ключ пользователя

Переменная пути запроса Тип Описание
userAlias String Псевдоним пользователя
keyUuid String ID ключа пользователя

Responses

STATUS 200 - Успешное удаление ключа.

STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Получение SSH ключа пользователя

GET admin/user/{userAlias}/key/{keyUuid}

Запрос возвращает информацию о SSH ключе пользователя

Переменная пути запроса Тип Описание
userAlias String Псевдоним пользователя
keyUuid String ID ключа пользователя

Responses

STATUS 200 - Успешное получение информации.

Пример ответа 
    
        {
            uuid:"0dee836e-aaaa-aaaa-aaaa-65318059de1f"
            publicKey:"ssh-ed25519 AAAAC3NzaC1lZFHNRPTE5AAAAIDkxja/2VmTEsJDTtf3bI4XYDpb58fvKfSjy7/u8EZeI your_email@gitflic.ru"
            title:"Название ключа"
            expiresAt:"2020-10-10T10-10-10Z"
            userUuid:"f1a94466-aaaa-aaaa-aaaa-744ec3bbd60c"
        }


STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Получение списка SSH ключей пользователей

GET /admin/user/{userAlias}/key

Запрос возвращает список всех SSH ключей пользователей

Переменная пути запроса Тип Описание
userAlias String Псевдоним пользователя

Responses

STATUS 200 - Успешное получение информации.

Пример ответа 
    
        {
            _embedded
                {
                    userPublicSshKeyModelList
                        [
                            {
                                uuid:"0dee836e-aaaa-aaaa-aaaa-65318059de1f"
                                publicKey:"ssh-ed25519 AAAAC3NzaC1lZFHNRPTE5AAAAIDkxja/2VmTEsJDTtf3bI4XYDpb58fvKfSjy7/u8EZeI your_email@gitflic.ru"
                                title:"Название ключа"
                                expiresAt:"2020-10-10T10-10-10Z"
                                userUuid:"f1a94466-aaaa-aaaa-aaaa-744ec3bbd60c"
                            }
                        page
                            {
                                size:10
                                totalElements:1
                                totalPages:1
                                number:0
                            }
                        ]
                }
        }


STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Получение информации для регистрации раннера на уровне инстанса.

GET /admin/runners/registration-info

Запрос возвращает необходимую информацию для регистрации раннера на уровне инстанса - URL и токен.

Responses

STATUS 200 - Успешное получение информации.

Пример ответа 
    
        id:"1"
        registrationUrl:"http://localhost:8080/-/runner/registration"
        registrationToken:"0d949a3a-aаaa-аааа-aааа-5fa8c3953e70"


STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Сброс токена для регистрации раннера на уровне инстанса.

POST /admin/runners/reset-registration-token

Запрос сбрасывает токен для регистрации раннера на уровне инстанса.

Responses

STATUS 200 - Успешый сброс токен.

STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Создание пользователя

POST /user

Запрос возвращает информацию о созданном пользователе.

Request

Параметр Описание
email E-mail создаваемого пользователя
password Пароль создаваемого пользователя
alias Алиас создаваемого пользователя

Поддерживаемый формат - JSON

Структура тела POST-запроса

{
    "email": "email@local.ru",
    "password": "password",
    "alias": "alias"
}

Responses

STATUS 200 - пример JSON:

Пример ответа 
    
{
    id:"f3657c3c-65dc-41ef-9346-917acb676944"
    username:"apiuser12332"
    name:null
    surname:null
    fullName:"apiuser12332"
    avatar:"http://localhost:8080/upload/img/5c10b16d-bccb-4207-95bb-76443bc44055.png"
    cover:null
}


STATUS 403 - Нет прав для доступа.

STATUS 422 - Пользователь с такими данными уже существует или введены некорректные данные.

Навигация