Initial commit

docs/api/barong_admin_api_v2.md

@@ -0,0 +1,976 @@
+# Barong
+RESTful AdminAPI for barong OAuth server
+
+## Version: 2.7.0
+
+### Security
+**BearerToken**  
+
+|basic|*Basic*|
+|---|---|
+|Description|Bearer Token authentication|
+|Name|Authorization|
+|In|header|
+
+### /api/v2/barong/admin/users/data_storage
+
+#### DELETE
+##### Description
+
+Deletes user's data storage record
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| uid | query | user uniq id | Yes | string |
+| title | query | data storage uniq title | Yes | string |
+
+##### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 204 | Deletes user's data storage record | [API_V2_Admin_Entities_UserWithKYC](#api_v2_admin_entities_userwithkyc) |
+| 401 | Invalid bearer token |  |
+
+### /api/v2/barong/admin/users/{uid}
+
+#### GET
+##### Description
+
+Returns user info
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| uid | path | user uniq id | Yes | string |
+
+##### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 200 | Returns user info | [API_V2_Admin_Entities_UserWithKYC](#api_v2_admin_entities_userwithkyc) |
+| 401 | Invalid bearer token |  |
+
+### /api/v2/barong/admin/users/documents/pending
+
+#### GET
+##### Description
+
+Returns array of users with pending or replaced documents as paginated collection
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| extended | query | When true endpoint returns full information about users | No | boolean |
+| uid | query |  | No | string |
+| email | query |  | No | string |
+| role | query |  | No | string |
+| first_name | query |  | No | string |
+| last_name | query |  | No | string |
+| country | query |  | No | string |
+| level | query |  | No | integer |
+| state | query |  | No | string |
+| range | query |  | No | string |
+| from | query | An integer represents the seconds elapsed since Unix epoch.If set, only records FROM the time will be retrieved. | No | integer |
+| to | query | An integer represents the seconds elapsed since Unix epoch.If set, only records BEFORE the time will be retrieved. | No | integer |
+| page | query | Page number (defaults to 1). | No | integer |
+| limit | query | Number of users per page (defaults to 100, maximum is 100). | No | integer |
+
+##### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 200 | Returns array of users with pending or replaced documents as paginated collection | [API_V2_Entities_User](#api_v2_entities_user) |
+| 401 | Invalid bearer token |  |
+
+### /api/v2/barong/admin/users
+
+#### PUT
+##### Description
+
+Update user attributes
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| uid | formData | user uniq id | Yes | string |
+| email | formData | User Email | No | string |
+| state | formData | user state | No | string |
+| otp | formData | user 2fa status | No | boolean |
+
+##### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 200 | User attributes were created |
+| 401 | Invalid bearer token |
+
+#### GET
+##### Description
+
+Returns array of users as paginated collection
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| extended | query | When true endpoint returns full information about users | No | boolean |
+| uid | query |  | No | string |
+| email | query |  | No | string |
+| role | query |  | No | string |
+| country | query |  | No | string |
+| level | query |  | No | integer |
+| state | query |  | No | string |
+| range | query |  | No | string |
+| ordering | query | If set, returned values will be sorted in specific order, defaults to 'asc'. | No | string |
+| order_by | query | Name of the field, which result will be ordered by. | No | string |
+| from | query | An integer represents the seconds elapsed since Unix epoch.If set, only records FROM the time will be retrieved. | No | integer |
+| to | query | An integer represents the seconds elapsed since Unix epoch.If set, only records BEFORE the time will be retrieved. | No | integer |
+| page | query | Page number (defaults to 1). | No | integer |
+| limit | query | Number of users per page (defaults to 100, maximum is 100). | No | integer |
+
+##### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 200 | Returns array of users as paginated collection | [API_V2_Entities_User](#api_v2_entities_user) |
+| 401 | Invalid bearer token |  |
+
+### /api/v2/barong/admin/users/role
+
+#### POST
+##### Description
+
+Update user role
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| uid | formData | user uniq id | Yes | string |
+| role | formData | user role | Yes | string |
+
+##### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 200 | User role was created |
+| 401 | Invalid bearer token |
+
+### /api/v2/barong/admin/users/update
+
+#### POST
+##### Description
+
+Update user attributes
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| uid | formData | user uniq id | Yes | string |
+| state | formData | user state | No | string |
+| otp | formData | user 2fa status | No | boolean |
+
+##### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 200 | User attributes were updated |
+| 401 | Invalid bearer token |
+
+### /api/v2/barong/admin/users/labels
+
+#### DELETE
+##### Description
+
+Deletes label for user
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| uid | query | user uniq id | Yes | string |
+| key | query | label key. [a-z0-9_-]+ should be used. Min - 3, max - 255 characters. | Yes | string |
+| scope | query | label key. [a-z0-9_-]+ should be used. Min - 3, max - 255 characters. | Yes | string |
+
+##### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 204 | Label was deleted |
+| 401 | Invalid bearer token |
+
+#### PUT
+##### Description
+
+Update user label scope
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| uid | formData | user uniq id | Yes | string |
+| key | formData | Label key. | Yes | string |
+| scope | formData | label key. [a-z0-9_-]+ should be used. Min - 3, max - 255 characters. | Yes | string |
+| description | formData | label description. [A-Za-z0-9_-] should be used. max - 255 characters. | No | string |
+| value | formData | Label value. | Yes | string |
+
+##### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 200 | Label was updated |
+| 400 | Required params are empty |
+| 401 | Invalid bearer token |
+| 404 | Record is not found |
+| 422 | Validation errors |
+
+#### POST
+##### Description
+
+Add label for user
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| uid | formData | user uniq id | Yes | string |
+| key | formData | label key. [a-z0-9_-]+ should be used. Min - 3, max - 255 characters. | Yes | string |
+| value | formData | label value. [A-Za-z0-9_-] should be used. Min - 3, max - 255 characters. | Yes | string |
+| description | formData | label description. [A-Za-z0-9_-] should be used. max - 255 characters. | No | string |
+| scope | formData | Label scope: 'public' or 'private'. Default is public | No | string |
+
+##### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 200 | Label was created |
+| 401 | Invalid bearer token |
+
+#### GET
+##### Description
+
+Returns array of users as paginated collection
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| key | query | Label key | Yes | string |
+| value | query | Label value | Yes | string |
+| page | query | Page number (defaults to 1). | No | integer |
+| limit | query | Number of users per page (defaults to 100, maximum is 100). | No | integer |
+
+##### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 200 | Returns array of users as paginated collection | [API_V2_Entities_User](#api_v2_entities_user) |
+| 401 | Invalid bearer token |  |
+
+### /api/v2/barong/admin/users/labels/update
+
+#### POST
+##### Description
+
+Update user label value
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| uid | formData | user uniq id | Yes | string |
+| key | formData | Label key. | Yes | string |
+| scope | formData | label key. [a-z0-9_-]+ should be used. Min - 3, max - 255 characters. | Yes | string |
+| value | formData | Label value. | Yes | string |
+| description | formData | label description. [A-Za-z0-9_-] should be used. max - 255 characters. | No | string |
+| replace | formData | When true label will be created if not exist | No | boolean |
+
+##### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 200 | Label was updated |
+| 400 | Required params are empty |
+| 401 | Invalid bearer token |
+| 404 | Record is not found |
+| 422 | Validation errors |
+
+### /api/v2/barong/admin/users/labels/list
+
+#### GET
+##### Description
+
+Returns existing labels keys and values
+
+##### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 200 | Returns existing labels keys and values |
+| 401 | Invalid bearer token |
+
+### /api/v2/barong/admin/users/comments
+
+#### DELETE
+##### Description
+
+Delete user's comment
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| id | query | comment uniq id | Yes | integer |
+
+##### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 204 | Delete user's comment | [API_V2_Admin_Entities_UserWithKYC](#api_v2_admin_entities_userwithkyc) |
+| 401 | Invalid bearer token |  |
+
+#### PUT
+##### Description
+
+Edit user's comment
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| id | formData | comment uniq id | Yes | integer |
+| title | formData | comment title | No | string |
+| data | formData | comment data | No | string |
+
+##### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 200 | Edit user's comment | [API_V2_Admin_Entities_UserWithKYC](#api_v2_admin_entities_userwithkyc) |
+| 401 | Invalid bearer token |  |
+
+#### POST
+##### Description
+
+Adds new user's comment
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| uid | formData | user uniq id | Yes | string |
+| title | formData | comment uniq title | Yes | string |
+| data | formData | comment data | Yes | string |
+
+##### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 201 | Adds new user's comment | [API_V2_Admin_Entities_UserWithKYC](#api_v2_admin_entities_userwithkyc) |
+| 401 | Invalid bearer token |  |
+
+### /api/v2/barong/admin/api_keys
+
+#### GET
+##### Description
+
+List all api keys for selected account.
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| uid | query | user uniq id | Yes | string |
+| ordering | query | If set, returned values will be sorted in specific order, defaults to 'asc'. | No | string |
+| order_by | query | Name of the field, which result will be ordered by. | No | string |
+| page | query | Page number (defaults to 1). | No | integer |
+| limit | query | Number of users per page (defaults to 100, maximum is 100). | No | integer |
+
+##### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 200 | List all api keys for selected account. | [API_V2_Entities_APIKey](#api_v2_entities_apikey) |
+| 401 | Invalid bearer token |  |
+
+### /api/v2/barong/admin/permissions
+
+#### PUT
+##### Description
+
+Update Permission
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| id | formData | Permission id | Yes | integer |
+| role | formData | permission field - role | No | string |
+| verb | formData | permission field - request verb | No | string |
+| path | formData | permission field - request path | No | string |
+| action | formData |  | No | string |
+| topic | formData |  | No | string |
+
+##### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 200 | Permission was updated |
+| 401 | Invalid bearer token |
+
+#### DELETE
+##### Description
+
+Deletes permission
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| id | query | permission id | Yes | integer |
+
+##### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 204 | Permission was deleted |
+| 401 | Invalid bearer token |
+
+#### POST
+##### Description
+
+Create permission
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| role | formData |  | Yes | string |
+| verb | formData |  | Yes | string |
+| path | formData |  | Yes | string |
+| action | formData |  | Yes | string |
+| topic | formData |  | No | string |
+
+##### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 200 | Permission was created |
+| 401 | Invalid bearer token |
+
+#### GET
+##### Description
+
+Returns array of permissions as paginated collection
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| page | query | Page number (defaults to 1). | No | integer |
+| limit | query | Number of users per page (defaults to 100, maximum is 100). | No | integer |
+
+##### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 200 | Returns array of permissions as paginated collection | [API_V2_Entities_Permission](#api_v2_entities_permission) |
+| 401 | Invalid bearer token |  |
+
+### /api/v2/barong/admin/activities/admin
+
+#### GET
+##### Description
+
+Returns array of activities as paginated collection
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| topic | query |  | No | string |
+| action | query |  | No | string |
+| uid | query |  | No | string |
+| email | query |  | No | string |
+| from | query | An integer represents the seconds elapsed since Unix epoch.If set, only records FROM the time will be retrieved. | No | integer |
+| to | query | An integer represents the seconds elapsed since Unix epoch.If set, only records BEFORE the time will be retrieved. | No | integer |
+| page | query | Page number (defaults to 1). | No | integer |
+| limit | query | Number of users per page (defaults to 100, maximum is 100). | No | integer |
+| target_uid | query |  | No | string |
+| range | query |  | No | string |
+
+##### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 200 | Returns array of activities as paginated collection | [API_V2_Admin_Entities_AdminActivity](#api_v2_admin_entities_adminactivity) |
+| 401 | Invalid bearer token |  |
+
+### /api/v2/barong/admin/activities
+
+#### GET
+##### Description
+
+Returns array of activities as paginated collection
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| topic | query |  | No | string |
+| action | query |  | No | string |
+| uid | query |  | No | string |
+| email | query |  | No | string |
+| from | query | An integer represents the seconds elapsed since Unix epoch.If set, only records FROM the time will be retrieved. | No | integer |
+| to | query | An integer represents the seconds elapsed since Unix epoch.If set, only records BEFORE the time will be retrieved. | No | integer |
+| page | query | Page number (defaults to 1). | No | integer |
+| limit | query | Number of users per page (defaults to 100, maximum is 100). | No | integer |
+
+##### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 200 | Returns array of activities as paginated collection | [API_V2_Admin_Entities_ActivityWithUser](#api_v2_admin_entities_activitywithuser) |
+| 401 | Invalid bearer token |  |
+
+### /api/v2/barong/admin/metrics
+
+#### GET
+##### Description
+
+Returns main statistic in the given time period
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| created_from | query |  | No | string |
+| created_to | query |  | No | string |
+
+##### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 200 | Returns main statistic in the given time period |
+| 401 | Invalid bearer token |
+
+### /api/v2/barong/admin/restrictions
+
+#### DELETE
+##### Description
+
+Delete restriction
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| id | query | Restriction id | Yes | integer |
+
+##### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 204 | Restriction was deleted |
+| 401 | Invalid bearer token |
+
+#### PUT
+##### Description
+
+Update restriction
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| id | formData | Restriction id | Yes | integer |
+| scope | formData |  | No | string |
+| category | formData |  | No | string |
+| value | formData |  | No | string |
+| state | formData |  | No | string |
+| code | formData |  | No | integer |
+
+##### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 200 | Restriction was updated |
+| 401 | Invalid bearer token |
+
+#### POST
+##### Description
+
+Create restriction
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| scope | formData |  | Yes | string |
+| value | formData |  | Yes | string |
+| category | formData |  | Yes | string |
+| state | formData |  | No | string |
+| code | formData |  | No | integer |
+
+##### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 200 | Restriction was created |
+| 401 | Invalid bearer token |
+
+#### GET
+##### Description
+
+Returns array of restrictions as a paginated collection
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| scope | query |  | No | string |
+| category | query |  | No | string |
+| range | query |  | No | string |
+| page | query | Page number (defaults to 1). | No | integer |
+| limit | query | Number of users per page (defaults to 100, maximum is 100). | No | integer |
+
+##### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 200 | Returns array of restrictions as a paginated collection | [API_V2_Entities_Restriction](#api_v2_entities_restriction) |
+| 401 | Invalid bearer token |  |
+
+### /api/v2/barong/admin/restrictions/whitelink
+
+#### POST
+##### Description
+
+Create whitelink
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| expire_time | formData | link will be active for (Time.now + expire_time in following range) | No | integer |
+| range | formData | In combination with expire_time gives full controll over token expiration | No | string |
+
+##### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 200 | Created whitelink |
+| 401 | Invalid bearer token |
+
+### /api/v2/barong/admin/profiles
+
+#### POST
+##### Description
+
+Create a profile for user
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| uid | formData |  | Yes | string |
+| first_name | formData |  | No | string |
+| last_name | formData |  | No | string |
+| dob | formData |  | No | date |
+| address | formData |  | No | string |
+| postcode | formData |  | No | string |
+| city | formData |  | No | string |
+| country | formData |  | No | string |
+| metadata | formData | Any additional key: value pairs in json string format | No | string |
+
+##### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 201 | Create a profile for user | [API_V2_Admin_Entities_Profile](#api_v2_admin_entities_profile) |
+| 400 | Required params are empty |  |
+| 401 | Invalid bearer token |  |
+| 422 | Validation errors |  |
+
+#### PUT
+##### Description
+
+Verify user's profile
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| uid | formData |  | Yes | string |
+| state | formData |  | Yes | string |
+
+##### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 200 | Verify user's profile | [API_V2_Admin_Entities_Profile](#api_v2_admin_entities_profile) |
+| 400 | Required params are empty |  |
+| 401 | Invalid bearer token |  |
+| 422 | Validation errors |  |
+
+#### GET
+##### Description
+
+Return all profiles
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| page | query | Page number (defaults to 1). | No | integer |
+| limit | query | Number of users per page (defaults to 100, maximum is 100). | No | integer |
+
+##### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 200 | Return all profiles | [API_V2_Admin_Entities_Profile](#api_v2_admin_entities_profile) |
+| 401 | Invalid bearer token |  |
+
+### /api/v2/barong/admin/levels
+
+#### GET
+##### Description
+
+Returns array of permissions as paginated collection
+
+##### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 200 | Returns array of permissions as paginated collection | [API_V2_Entities_Level](#api_v2_entities_level) |
+| 401 | Invalid bearer token |  |
+
+### /api/v2/barong/admin/abilities
+
+#### GET
+##### Description
+
+Get all roles and admin_permissions of barong cancan.
+
+##### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 200 | Get all roles and admin_permissions of barong cancan. |
+
+### Models
+
+#### API_V2_Admin_Entities_UserWithKYC
+
+Adds new user's comment
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| email | string | User Email | No |
+| uid | string | User UID | No |
+| role | string | User role | No |
+| level | integer | User level | No |
+| otp | boolean | is 2FA enabled for account | No |
+| state | string | User state: active, pending, inactive | No |
+| referral_uid | string | UID of referrer | No |
+| data | string | Additional phone and profile info | No |
+| profiles | [API_V2_Admin_Entities_Profile](#api_v2_admin_entities_profile) |  | No |
+| labels | [API_V2_Entities_AdminLabelView](#api_v2_entities_adminlabelview) |  | No |
+| phones | [API_V2_Admin_Entities_Phone](#api_v2_admin_entities_phone) |  | No |
+| documents | [API_V2_Admin_Entities_Document](#api_v2_admin_entities_document) |  | No |
+| data_storages | [API_V2_Entities_DataStorage](#api_v2_entities_datastorage) |  | No |
+| comments | [API_V2_Entities_Comment](#api_v2_entities_comment) |  | No |
+| created_at | string |  | No |
+| updated_at | string |  | No |
+
+#### API_V2_Admin_Entities_Profile
+
+Return all profiles
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| first_name | string | First Name | No |
+| last_name | string | Last name | No |
+| dob | date | Birth date | No |
+| address | string | Address | No |
+| postcode | string | Address Postcode | No |
+| city | string | City name | No |
+| country | string | Country name | No |
+| state | string | Profile state: drafted, submitted, verified, rejected | No |
+| metadata | object | Profile additional fields | No |
+| created_at | string |  | No |
+| updated_at | string |  | No |
+
+#### API_V2_Entities_AdminLabelView
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| key | string | Label key. [a-z0-9_-]+ should be used. Min - 3, max - 255 characters. | No |
+| value | string | Label value. [A-Za-z0-9_-] should be used. Min - 3, max - 255 characters. | No |
+| scope | string | Label scope: 'public' or 'private' | No |
+| description | string | Label desc: json string with any additional information | No |
+| created_at | string |  | No |
+| updated_at | string |  | No |
+
+#### API_V2_Admin_Entities_Phone
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| country | string | Phone country | No |
+| number | string | Phone number | No |
+| validated_at | s (g) | Phone validation date | No |
+
+#### API_V2_Admin_Entities_Document
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| upload | string | File url | No |
+| doc_type | string | Document type: passport, driver license, utility bill, identity card, institutional, address, residental | No |
+| doc_number | string | document number: AB123123 type | No |
+| doc_expire | string | Expire date of uploaded documents | No |
+| metadata | string | Any additional stored data | No |
+| created_at | string |  | No |
+| updated_at | string |  | No |
+
+#### API_V2_Entities_DataStorage
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| title | string | Any additional data title | No |
+| data | string | Any additional data json key:value pairs | No |
+| created_at | string |  | No |
+| updated_at | string |  | No |
+
+#### API_V2_Entities_Comment
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| id | integer | Comment id | No |
+| author_uid | string | Comment author UID | No |
+| title | string | Comment title | No |
+| data | string | Comment plain text | No |
+| created_at | string |  | No |
+| updated_at | string |  | No |
+
+#### API_V2_Entities_User
+
+Returns array of users as paginated collection
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| email | string | User Email | No |
+| uid | string | User UID | No |
+| role | string | User role | No |
+| level | integer | User level | No |
+| otp | boolean | is 2FA enabled for account | No |
+| state | string | User state: active, pending, inactive | No |
+| referral_uid | string | UID of referrer | No |
+| data | string | Additional phone and profile info | No |
+
+#### API_V2_Entities_APIKey
+
+List all api keys for selected account.
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| kid | string | JWT public key | No |
+| algorithm | string | Cryptographic hash function type | No |
+| scope | string | Serialized array of scopes | No |
+| state | string | active/non-active state of key | No |
+| secret | string | Api key secret | No |
+| created_at | string |  | No |
+| updated_at | string |  | No |
+
+#### API_V2_Entities_Permission
+
+Returns array of permissions as paginated collection
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| id | integer | Permission id | No |
+| action | string | Permission action: accept (allow access (drop access), audit (record activity) | No |
+| role | string | Permission user role | No |
+| verb | string | Permission verb: put, post, delete, get | No |
+| path | string | API path | No |
+| topic | string | Permission topic: general, session etc | No |
+| created_at | string |  | No |
+| updated_at | string |  | No |
+
+#### API_V2_Admin_Entities_AdminActivity
+
+Returns array of activities as paginated collection
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| user_ip | string | User IP | No |
+| user_agent | string | User Browser Agent | No |
+| topic | string | Defined topic (session, adjustments) or general by default | No |
+| action | string | API action: POST => 'create', PUT => 'update', GET => 'read', DELETE => 'delete', PATCH => 'update' or system if there is no match of HTTP method | No |
+| result | string | Status of API response: succeed, failed, denied | No |
+| data | string | Parameters which was sent to specific API endpoint | No |
+| admin | [API_V2_Entities_User](#api_v2_entities_user) |  | No |
+| target | [API_V2_Entities_User](#api_v2_entities_user) |  | No |
+| created_at | string |  | No |
+
+#### API_V2_Admin_Entities_ActivityWithUser
+
+Returns array of activities as paginated collection
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| user_ip | string | User IP | No |
+| user_agent | string | User Browser Agent | No |
+| topic | string | Defined topic (session, adjustments) or general by default | No |
+| action | string | API action: POST => 'create', PUT => 'update', GET => 'read', DELETE => 'delete', PATCH => 'update' or system if there is no match of HTTP method | No |
+| result | string | Status of API response: succeed, failed, denied | No |
+| data | string | Parameters which was sent to specific API endpoint | No |
+| user | [API_V2_Entities_User](#api_v2_entities_user) |  | No |
+| created_at | string |  | No |
+
+#### API_V2_Entities_Restriction
+
+Returns array of restrictions as a paginated collection
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| id | integer | Restriction id | No |
+| category | string | Restriction categories: blacklist, maintenance, whitelist, blocklogin | No |
+| scope | string | Restriction scopes: continent, country, ip, ip_subnet, all | No |
+| value | string | Restriction value: IP address, country abbreviation, all | No |
+| code | integer | Restriction codes: {"continent"=>423, "country"=>423, "ip_subnet"=>403, "ip"=>401, "all"=>401} | No |
+| state | string | Restriction states: disabled, enabled | No |
+| created_at | string |  | No |
+| updated_at | string |  | No |
+
+#### API_V2_Entities_Level
+
+Returns array of permissions as paginated collection
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| id | integer | Level identifier, level number | No |
+| key | string | Label key. [A-Za-z0-9_-] should be used. Min - 3, max - 255 characters. | No |
+| value | string | Label value. [A-Za-z0-9_-] should be used. Min - 3, max - 255 characters. | No |
+
+#### API_V2_Admin_Entities_UserWithProfile
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| email | string | User Email | No |
+| uid | string | User UID | No |
+| role | string | User role | No |
+| level | integer | User level | No |
+| otp | boolean | is 2FA enabled for account | No |
+| state | string | User state: active, pending, inactive | No |
+| referral_uid | string | UID of referrer | No |
+| data | string | Additional phone and profile info | No |
+| profiles | [API_V2_Admin_Entities_Profile](#api_v2_admin_entities_profile) |  | No |
+| created_at | string |  | No |
+| updated_at | string |  | No |

docs/api/barong_management_api_v2.md

@@ -0,0 +1,678 @@
+# Barong
+Management API for barong OAuth server
+
+## Version: 2.7.0
+
+### Security
+**SecurityScope**  
+
+|basic|*Basic*|
+|---|---|
+|Description|JWT should have signature keychains|
+|Name|Authorization|
+
+### /api/v2/barong/management/labels/delete
+
+#### POST
+##### Description
+
+Delete a label with 'private' scope
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| user_uid | formData | User uid | Yes | string |
+| key | formData | Label key. | Yes | string |
+
+##### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 201 | Delete a label with 'private' scope |
+
+### /api/v2/barong/management/labels
+
+#### PUT
+##### Description
+
+Update a label with 'private' scope
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| user_uid | formData | User uid | Yes | string |
+| key | formData | Label key. | Yes | string |
+| value | formData | Label value. | Yes | string |
+| description | formData | Label desc. | No | string |
+| replace | formData | When true label will be created if not exist | No | boolean |
+
+##### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 200 | Update a label with 'private' scope | [API_V2_Entities_Label](#api_v2_entities_label) |
+
+#### POST
+##### Description
+
+Create a label with 'private' scope and assigns to users
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| user_uid | formData | User uid | Yes | string |
+| key | formData | Label key. | Yes | string |
+| value | formData | Label value. | Yes | string |
+| description | formData | Label desc. | No | string |
+
+##### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 201 | Create a label with 'private' scope and assigns to users | [API_V2_Entities_Label](#api_v2_entities_label) |
+
+### /api/v2/barong/management/labels/list
+
+#### POST
+##### Description
+
+Get user collection filtered on label attributes
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| user_uid | formData | User uid | Yes | string |
+
+##### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 201 | Get user collection filtered on label attributes | [API_V2_Entities_AdminLabelView](#api_v2_entities_adminlabelview) |
+
+### /api/v2/barong/management/labels/filter/users
+
+#### POST
+##### Description
+
+Get all labels assigned to users
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| key | formData | Label key. | Yes | string |
+| value | formData | Label value. | No | string |
+| scope | formData | Label scope. | No | string |
+| extended | formData | When true endpoint returns full information about users | No | boolean |
+| range | formData |  | No | string |
+| page | formData | Page number (defaults to 1). | No | integer |
+| limit | formData | Number of users per page (defaults to 100, maximum is 100). | No | integer |
+
+##### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 201 | Get all labels assigned to users | [API_V2_Entities_User](#api_v2_entities_user) |
+
+### /api/v2/barong/management/users/import
+
+#### POST
+##### Description
+
+Imports an existing user
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| email | formData | User Email | Yes | string |
+| password_digest | formData | User Password Hash | Yes | string |
+| referral_uid | formData | Referral uid | No | string |
+| phone | formData | Phone | No | string |
+| first_name | formData | First Name | No | string |
+| last_name | formData | Last Name | No | string |
+| dob | formData | Birth date | No | date |
+| address | formData | Address | No | string |
+| postcode | formData | Postcode | No | string |
+| city | formData | City | No | string |
+| country | formData | Country | No | string |
+| state | formData | State | No | string |
+
+##### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 201 | Imports an existing user | [API_V2_Management_Entities_UserWithProfile](#api_v2_management_entities_userwithprofile) |
+
+### /api/v2/barong/management/users/update
+
+#### POST
+##### Description
+
+Updates role and data fields of existing user
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| uid | formData | User Uid | Yes | string |
+| role | formData | User Role | No | string |
+| data | formData | Any additional key:value pairs in json format | No | string |
+
+##### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 201 | Updates role and data fields of existing user | [API_V2_Management_Entities_UserWithProfile](#api_v2_management_entities_userwithprofile) |
+
+### /api/v2/barong/management/users
+
+#### POST
+##### Description
+
+Creates new user
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| email | formData | User Email | Yes | string |
+| password | formData | User Password | Yes | string |
+| referral_uid | formData | Referral uid | No | string |
+
+##### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 201 | Creates new user | [API_V2_Management_Entities_UserWithProfile](#api_v2_management_entities_userwithprofile) |
+
+### /api/v2/barong/management/users/list
+
+#### POST
+##### Description
+
+Returns array of users as collection
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| extended | formData | When true endpoint returns full information about users | No | boolean |
+| range | formData |  | No | string |
+| from | formData | An integer represents the seconds elapsed since Unix epoch.If set, only records FROM the time will be retrieved. | No | integer |
+| to | formData | An integer represents the seconds elapsed since Unix epoch.If set, only records BEFORE the time will be retrieved. | No | integer |
+| page | formData | Page number (defaults to 1). | No | integer |
+| limit | formData | Number of users per page (defaults to 100, maximum is 100). | No | integer |
+
+##### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 201 | Returns array of users as collection | [API_V2_Entities_User](#api_v2_entities_user) |
+
+### /api/v2/barong/management/users/get
+
+#### POST
+##### Description
+
+Get users and profile information
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| uid | formData | User uid | No | string |
+| email | formData | User email | No | string |
+| phone_num | formData | User phone number | No | string |
+
+##### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 201 | Get users and profile information | [API_V2_Management_Entities_UserWithKYC](#api_v2_management_entities_userwithkyc) |
+
+### /api/v2/barong/management/profiles
+
+#### POST
+##### Description
+
+Imports a profile for user
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| uid | formData | User Uid | Yes | string |
+| first_name | formData | First Name | No | string |
+| last_name | formData | Last Name | No | string |
+| dob | formData | Birth date | No | date |
+| address | formData | Address | No | string |
+| postcode | formData | Postcode | No | string |
+| city | formData | City | No | string |
+| country | formData | Country | No | string |
+| state | formData | State | No | string |
+| metadata | formData | Metadata | No | string |
+
+##### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 201 | Imports a profile for user | [API_V2_Management_Entities_UserWithProfile](#api_v2_management_entities_userwithprofile) |
+
+### /api/v2/barong/management/phones/delete
+
+#### POST
+##### Description
+
+Delete phone number for user
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| uid | formData | User uid | Yes | string |
+| number | formData | User phone number | Yes | string |
+
+##### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 201 | Delete phone number for user | [API_V2_Management_Entities_Phone](#api_v2_management_entities_phone) |
+
+### /api/v2/barong/management/phones
+
+#### POST
+##### Description
+
+Create phone number for user
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| uid | formData | User uid | Yes | string |
+| number | formData | User phone number | Yes | string |
+
+##### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 201 | Create phone number for user | [API_V2_Management_Entities_Phone](#api_v2_management_entities_phone) |
+
+### /api/v2/barong/management/phones/get
+
+#### POST
+##### Description
+
+Get user phone numbers
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| uid | formData | User uid | Yes | string |
+
+##### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 201 | Get user phone numbers | [API_V2_Management_Entities_Phone](#api_v2_management_entities_phone) |
+
+### /api/v2/barong/management/otp/sign
+
+#### POST
+##### Description
+
+Sign request with barong signature
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| user_uid | formData | Account UID | Yes | string |
+| otp_code | formData | Code from Google Authenticator | Yes | string |
+
+##### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 201 | Sign request with barong signature |
+
+### /api/v2/barong/management/documents
+
+#### POST
+##### Description
+
+Push documents to barong DB
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| uid | formData | User uid | Yes | string |
+| doc_type | formData | Document type | Yes | string |
+| doc_number | formData | Document number | Yes | string |
+| filename | formData | Document name | Yes | string |
+| file_ext | formData | Document file extension | Yes | string |
+| upload | formData | Base64 encoded document | Yes | string |
+| doc_expire | formData | Document expiration date | No | date |
+| update_labels | formData | If set to false, user label will not be created/updated | No | boolean |
+| metadata | formData | Any additional key: value pairs in json string format | No | string |
+
+##### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 201 | Push documents to barong DB |
+
+### /api/v2/barong/management/service_accounts/delete
+
+#### POST
+##### Description
+
+Delete specific service_account
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| uid | formData | service_account uid | Yes | string |
+
+##### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 201 | Delete specific service_account | [API_V2_Entities_ServiceAccounts](#api_v2_entities_serviceaccounts) |
+
+### /api/v2/barong/management/service_accounts/create
+
+#### POST
+##### Description
+
+Create service_account
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| owner_uid | formData | owner uid | Yes | string |
+| service_account_role | formData | service_account role | Yes | string |
+| service_account_uid | formData | service_account uid | No | string |
+| service_account_email | formData | service_account email | No | string |
+
+##### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 201 | Create service_account | [API_V2_Entities_ServiceAccounts](#api_v2_entities_serviceaccounts) |
+
+### /api/v2/barong/management/service_accounts/list
+
+#### POST
+##### Description
+
+Get service_accounts as a paginated collection
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| page | formData | Page number (defaults to 1). | No | integer |
+| limit | formData | Number of users per page (defaults to 100, maximum is 100). | No | integer |
+| owner_uid | formData | owner uid | No | string |
+| owner_email | formData | owner email | No | string |
+
+##### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 201 | Get service_accounts as a paginated collection | [API_V2_Entities_ServiceAccounts](#api_v2_entities_serviceaccounts) |
+
+### /api/v2/barong/management/service_accounts/get
+
+#### POST
+##### Description
+
+Get specific service_account information
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+| uid | formData | service_account uid | No | string |
+| email | formData | service_account email | No | string |
+
+##### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 201 | Get specific service_account information | [API_V2_Entities_ServiceAccounts](#api_v2_entities_serviceaccounts) |
+
+### /api/v2/barong/management/timestamp
+
+#### POST
+##### Description
+
+Returns server time in seconds since Unix epoch.
+
+##### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 201 | Returns server time in seconds since Unix epoch. |
+
+### Models
+
+#### API_V2_Entities_Label
+
+Create a label with 'private' scope and assigns to users
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| key | string | Label key. [a-z0-9_-]+ should be used. Min - 3, max - 255 characters. | No |
+| value | string | Label value. [A-Za-z0-9_-] should be used. Min - 3, max - 255 characters. | No |
+| scope | string | Label scope: 'public' or 'private' | No |
+| created_at | string |  | No |
+| updated_at | string |  | No |
+
+#### API_V2_Entities_AdminLabelView
+
+Get user collection filtered on label attributes
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| key | string | Label key. [a-z0-9_-]+ should be used. Min - 3, max - 255 characters. | No |
+| value | string | Label value. [A-Za-z0-9_-] should be used. Min - 3, max - 255 characters. | No |
+| scope | string | Label scope: 'public' or 'private' | No |
+| description | string | Label desc: json string with any additional information | No |
+| created_at | string |  | No |
+| updated_at | string |  | No |
+
+#### API_V2_Entities_User
+
+Returns array of users as collection
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| email | string | User Email | No |
+| uid | string | User UID | No |
+| role | string | User role | No |
+| level | integer | User level | No |
+| otp | boolean | is 2FA enabled for account | No |
+| state | string | User state: active, pending, inactive | No |
+| referral_uid | string | UID of referrer | No |
+| data | string | Additional phone and profile info | No |
+
+#### API_V2_Management_Entities_UserWithProfile
+
+Imports a profile for user
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| email | string | User Email | No |
+| uid | string | User UID | No |
+| role | string | User role | No |
+| level | integer | User level | No |
+| otp | boolean | is 2FA enabled for account | No |
+| state | string | User state: active, pending, inactive | No |
+| referral_uid | string | UID of referrer | No |
+| data | string | Additional phone and profile info | No |
+| profiles | [API_V2_Management_Entities_Profile](#api_v2_management_entities_profile) |  | No |
+| created_at | string |  | No |
+| updated_at | string |  | No |
+
+#### API_V2_Management_Entities_Profile
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| first_name | string | First Name | No |
+| last_name | string | Last name | No |
+| dob | date | Birth date | No |
+| address | string | Address | No |
+| postcode | string | Address Postcode | No |
+| city | string | City name | No |
+| country | string | Country name | No |
+| state | string | Profile state: drafted, submitted, verified, rejected | No |
+| metadata | object | Profile additional fields | No |
+| created_at | string |  | No |
+| updated_at | string |  | No |
+
+#### API_V2_Management_Entities_UserWithKYC
+
+Get users and profile information
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| email | string | User Email | No |
+| uid | string | User UID | No |
+| role | string | User role | No |
+| level | integer | User level | No |
+| otp | boolean | is 2FA enabled for account | No |
+| state | string | User state: active, pending, inactive | No |
+| referral_uid | string | UID of referrer | No |
+| data | string | Additional phone and profile info | No |
+| profiles | [API_V2_Management_Entities_Profile](#api_v2_management_entities_profile) |  | No |
+| labels | [API_V2_Entities_AdminLabelView](#api_v2_entities_adminlabelview) |  | No |
+| phones | [API_V2_Management_Entities_Phone](#api_v2_management_entities_phone) |  | No |
+| documents | [API_V2_Management_Entities_Document](#api_v2_management_entities_document) |  | No |
+| data_storages | [API_V2_Entities_DataStorage](#api_v2_entities_datastorage) |  | No |
+| comments | [API_V2_Entities_Comment](#api_v2_entities_comment) |  | No |
+| created_at | string |  | No |
+| updated_at | string |  | No |
+
+#### API_V2_Management_Entities_Phone
+
+Get user phone numbers
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| country | string | Phone country | No |
+| number | string | Phone Number | No |
+| validated_at | s (g) | Phone validation date | No |
+
+#### API_V2_Management_Entities_Document
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| upload | string | File url | No |
+| doc_type | string | Document type: passport, driver license, utility bill, identity card, institutional, address, residental | No |
+| doc_number | string | Document number: AB123123 type | No |
+| doc_expire | string | Expire date of uploaded documents | No |
+| metadata | string | Any additional stored data | No |
+| created_at | string |  | No |
+| updated_at | string |  | No |
+
+#### API_V2_Entities_DataStorage
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| title | string | Any additional data title | No |
+| data | string | Any additional data json key:value pairs | No |
+| created_at | string |  | No |
+| updated_at | string |  | No |
+
+#### API_V2_Entities_Comment
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| id | integer | Comment id | No |
+| author_uid | string | Comment author UID | No |
+| title | string | Comment title | No |
+| data | string | Comment plain text | No |
+| created_at | string |  | No |
+| updated_at | string |  | No |
+
+#### API_V2_Entities_ServiceAccounts
+
+Get specific service_account information
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| email | string | User Email | No |
+| uid | string | User UID | No |
+| role | string | Service Account Role | No |
+| level | integer | User Level | No |
+| state | string | Service Account State: active, disabled | No |
+| user | [API_V2_Entities_User](#api_v2_entities_user) |  | No |
+| created_at | string |  | No |
+| updated_at | string |  | No |
+
+#### API_V2_Entities_APIKey
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| kid | string | JWT public key | No |
+| algorithm | string | Cryptographic hash function type | No |
+| scope | string | Serialized array of scopes | No |
+| state | string | active/non-active state of key | No |
+| secret | string | Api key secret | No |
+| created_at | string |  | No |
+| updated_at | string |  | No |
+
+#### API_V2_Entities_UserWithFullInfo
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| email | string | User Email | No |
+| uid | string | User UID | No |
+| role | string | User role | No |
+| level | integer | User level | No |
+| otp | boolean | is 2FA enabled for account | No |
+| state | string | User state: active, pending, inactive | No |
+| referral_uid | string | UID of referrer | No |
+| data | string | Additional phone and profile info | No |
+| csrf_token | string | Сsrf protection token | No |
+| labels | [API_V2_Entities_Label](#api_v2_entities_label) |  | No |
+| phones | [API_V2_Entities_Phone](#api_v2_entities_phone) |  | No |
+| profiles | [API_V2_Entities_Profile](#api_v2_entities_profile) |  | No |
+| data_storages | [API_V2_Entities_DataStorage](#api_v2_entities_datastorage) |  | No |
+| created_at | string |  | No |
+| updated_at | string |  | No |
+
+#### API_V2_Entities_Phone
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| country | string | Phone country | No |
+| number | string | Submasked phone number | No |
+| validated_at | s (g) | Phone validation date | No |
+
+#### API_V2_Entities_Profile
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| first_name | string | First Name | No |
+| last_name | string | Submasked last name | No |
+| dob | date | Submasked birth date | No |
+| address | string | Address | No |
+| postcode | string | Address Postcode | No |
+| city | string | City name | No |
+| country | string | Country name | No |
+| state | string | Profile state: drafted, submitted, verified, rejected | No |
+| metadata | object | Profile additional fields | No |
+| created_at | string |  | No |
+| updated_at | string |  | No |

docs/api/swagger/user_api.json

@@ -0,0 +1 @@
+{"info":{"title":"Barong","description":"RESTful API for barong OAuth server","version":"2.7.0"},"swagger":"2.0","produces":["application/json"],"host":"www.alvand.local","basePath":"/api/v2/barong","tags":[{"name":"api","description":"Operations about apis"}],"paths":{"/api/v2/barong/identity/users/password/reset":{"post":{"description":"Sets new account password(for forgot password)","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"email","description":"user email","type":"string","required":true},{"in":"formData","name":"code","description":"code from email again","type":"string","required":true},{"in":"formData","name":"password","description":"User new password","type":"string","required":true},{"in":"formData","name":"confirm_password","description":"User new password","type":"string","required":true}],"responses":{"201":{"description":"Resets password"},"400":{"description":"Required params are empty"},"404":{"description":"Record is not found"},"422":{"description":"Validation errors"}},"tags":["api"],"operationId":"postApiV2BarongIdentityUsersPasswordReset"}},"/api/v2/barong/identity/users/password/confirm_code":{"post":{"description":"Just check confirm code for reset password(check authorization for forget password)","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"email","description":"Account email","type":"string","required":true},{"in":"formData","name":"code","description":"Confirm code","type":"string","required":true},{"in":"formData","name":"captcha_response","description":"Response from captcha widget","type":"string","required":false}],"responses":{"201":{"description":"reset code is ok"},"400":{"description":"Required params are missing"},"422":{"description":"Validation errors"},"404":{"description":"User doesn't exist"}},"tags":["api"],"operationId":"postApiV2BarongIdentityUsersPasswordConfirmCode"}},"/api/v2/barong/identity/users/password/generate_code":{"post":{"description":"Send password reset instructions(forget password)","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"email","description":"Account email","type":"string","required":true},{"in":"formData","name":"captcha_response","description":"Response from captcha widget","type":"string","required":false}],"responses":{"201":{"description":"Generated password reset code"},"400":{"description":"Required params are missing"},"422":{"description":"Validation errors"},"404":{"description":"User doesn't exist"}},"tags":["api"],"operationId":"postApiV2BarongIdentityUsersPasswordGenerateCode"}},"/api/v2/barong/identity/users/email/confirm_email":{"post":{"description":"Confirms an account by Authorization code (verify user email and achieve first label)","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"code","description":"Code from email","type":"string","required":true},{"in":"formData","name":"email","description":"user email","type":"string","required":true}],"responses":{"201":{"description":"Confirms an account by Authorization code (verify user email and achieve first label)","schema":{"$ref":"#/definitions/API_V2_Entities_UserWithFullInfo"}},"400":{"description":"Required code are missing"},"422":{"description":"Validation errors"}},"tags":["api"],"operationId":"postApiV2BarongIdentityUsersEmailConfirmEmail"}},"/api/v2/barong/identity/users/email/generate_email_code":{"post":{"description":"Send confirmations instructions (code in email)","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"email","description":"Account email","type":"string","required":true},{"in":"formData","name":"captcha_response","description":"Response from captcha widget","type":"string","required":false}],"responses":{"201":{"description":"Generated verification code"},"400":{"description":"Required params are missing"},"422":{"description":"Validation errors"}},"tags":["api"],"operationId":"postApiV2BarongIdentityUsersEmailGenerateEmailCode"}},"/api/v2/barong/identity/users/register_geetest":{"get":{"description":"Register Geetest captcha","produces":["application/json"],"responses":{"200":{"description":"Register Geetest captcha"}},"tags":["api"],"operationId":"getApiV2BarongIdentityUsersRegisterGeetest"}},"/api/v2/barong/identity/users":{"post":{"description":"Creates new user (sign up)","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"email","description":"User Email","type":"string","required":true},{"in":"formData","name":"password","description":"User Password","type":"string","required":true},{"in":"formData","name":"refid","description":"Referral uid","type":"string","required":false},{"in":"formData","name":"captcha_response","description":"Response from captcha widget","type":"string","required":false},{"in":"formData","namLine truncated