Documentation Powered by ReDoc

auth-service (v1)

Download OpenAPI specification:Download

auth-service

Authentication

Basic

Security Scheme Type HTTP
HTTP Authorization Scheme basic

InternalAuthorization

Внутренняя авторизация

Security Scheme Type API Key
Header parameter name: X-Internal-Authorization

CaptchaToken

Security Scheme Type API Key
Header parameter name: X-Captcha-Token

roles

Получить список ролей

get /roles
http://localhost:8080/api/v1/roles
Authorizations:
InternalAuthorization

Responses

200

Ok

400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "roles":
    [
    ]
}

resources

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

get /resources
http://localhost:8080/api/v1/resources
Authorizations:
InternalAuthorization
path Parameters
user_name
required
string

имя пользователя

Responses

200

Ok

400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • [
    ]
]

password_recovery

Создание ссылки восстановления пароля, которая отправляется на email

post /password_recovery
http://localhost:8080/api/v1/password_recovery
Authorizations:
InternalAuthorization
Request Body schema: application/json
email
string

Email пользователя

Responses

201

Ok

400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "email": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "access_token": "string",
  • "token_type": "string",
  • "expires_in": 0,
  • "refresh_token": "string"
}

set_password

Установить пароль пользователя

post /set_password
http://localhost:8080/api/v1/set_password
Authorizations:
InternalAuthorization
Request Body schema: application/json
key
string

ключ подтверждения (используется при обновлении через set-password)

password
string

новый пароль

Responses

201

Ok

400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "key": "string",
  • "password": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "access_token": "string",
  • "token_type": "string",
  • "expires_in": 0,
  • "refresh_token": "string"
}

update_password

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

post /update_password
http://localhost:8080/api/v1/update_password
Authorizations:
InternalAuthorization
Request Body schema: application/json
name
string

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

password
string

новый пароль

Responses

201

Ok

400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "password": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "access_token": "string",
  • "token_type": "string",
  • "expires_in": 0,
  • "refresh_token": "string"
}

registration

Регистрация новой компании и пользователя

post /registration
http://localhost:8080/api/v1/registration
Authorizations:
CaptchaToken
query Parameters
utm_source
string
utm_medium
string
utm_campaign
string
utm_content
string
utm_term
string
author
string
referer
string
Request Body schema: application/json
user
object (RegistrationUser)

данные пользователя для регистрации

company
object (Company)

компания

Responses

201

Ok

400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "user":
    {
    },
  • "company":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "access_token": "string",
  • "token_type": "string",
  • "expires_in": 0,
  • "refresh_token": "string"
}

verify

Проверка кода подтверждения

post /captcha/verify
http://localhost:8080/api/v1/captcha/verify
Authorizations:
InternalAuthorization
Request Body schema: application/json
code
string

код подтверждения

phone
string

телефон получателя

Responses

201

Ok

400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "string",
  • "phone": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "captcha_token": "string"
}

new

Отправка кода подтверждения

post /captcha/new
http://localhost:8080/api/v1/captcha/new
Authorizations:
InternalAuthorization
Request Body schema: application/json
phone
string

телефон получателя

Responses

201

Ok

400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "phone": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": 400,
  • "error": "string",
  • "error_description": "string"
}

validate

Проверка срока действия кода установки пароля

get /validate
http://localhost:8080/api/v1/validate

Проверка срока действия кода установки пароля

Authorizations:
InternalAuthorization
query Parameters
code
string

Код установки пароля

Responses

200

Ok

400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": 400,
  • "error": "string",
  • "error_description": "string"
}

resend_email

Выслать письмо об активации аккаунта

post /resend_email
http://localhost:8080/api/v1/resend_email

Выслать письмо об активации аккаунта

Authorizations:
InternalAuthorization
Request Body schema: application/json
username
string

Логин пользователя

Responses

200

Ok

400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "username": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": 400,
  • "error": "string",
  • "error_description": "string"
}

check_registration

Проверка - подтвердил ли пользователь регистрацию

get /check_registration
http://localhost:8080/api/v1/check_registration

Проверка - подтвердил ли пользователь регистрацию

Authorizations:
InternalAuthorization
query Parameters
username
string

Логин пользователя

Responses

200
400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "registered": true
}

user_check

Проверка существования логина/email

get /registration/user_check
http://localhost:8080/api/v1/registration/user_check

Проверка существования логина/email

Authorizations:
InternalAuthorization
query Parameters
username
string

Логин пользователя

email
string

Email пользователя

Responses

200
400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "username_found": true,
  • "email_found": true
}

login

Логин пользователя

post /login
http://localhost:8080/api/v1/login
Authorizations:
InternalAuthorization
Request Body schema: application/json
name
string

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

password
string

пароль

role_name
string Nullable

наименование роли

email
string Nullable

почта пользователя

Responses

201

Ok

400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "password": "string",
  • "role_name": "string",
  • "email": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "access_token": "string",
  • "token_type": "string",
  • "expires_in": 0,
  • "refresh_token": "string"
}

logout

Логаут пользователя

post /logout
http://localhost:8080/api/v1/logout
Authorizations:
InternalAuthorization

Responses

201

Ok

400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": 400,
  • "error": "string",
  • "error_description": "string"
}

token

Аутентификация пользователя

post /token
http://localhost:8080/api/v1/token
Authorizations:
InternalAuthorization
Request Body schema: application/json
grant_type
string
Enum: "refresh_token" "password" "authorization_code"

Тип аутентификации

username
string Nullable

Логин пользователя

code
string Nullable

Код авторизации пользователя

password
string Nullable

Пароль пользователя

refresh_token
string Nullable

refresh_token

Responses

201

Ok

400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "grant_type": "refresh_token",
  • "username": "string",
  • "code": "string",
  • "password": "string",
  • "refresh_token": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "access_token": "string",
  • "token_type": "string",
  • "expires_in": 0,
  • "refresh_token": "string"
}

password

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

put /password
http://localhost:8080/api/v1/password

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

Authorizations:
InternalAuthorization
Request Body schema: application/json
token
string

Токен восстановления пароля

new_password
string

Новый пароль пользователя

Responses

201

Ok

400

Неверные параметры запроса

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "token": "string",
  • "new_password": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": 400,
  • "error": "string",
  • "error_description": "string"
}