Documentation

API Docs Technical Docs User Guides Changelogs

Versions

# Barong

RESTful API for barong OAuth server

#Version: 2.7.0

# Security

BearerToken

jwt	undefined
Description	Bearer Token authentication
Name	Authorization
In	header

# /api/v2/barong/identity/users/password/confirm_code

#POST

#Description

Sets new account password

#Parameters

Name	Located in	Description	Required	Schema
reset_password_token	formData	Token from email	Yes	string
password	formData	User password	Yes	string
confirm_password	formData	User password	Yes	string

#Responses

Code	Description
201	Resets password
400	Required params are empty
404	Record is not found
422	Validation errors

# /api/v2/barong/identity/users/password/generate_code

#POST

#Description

Send password reset instructions

#Parameters

Name	Located in	Description	Required	Schema
email	formData	Account email	Yes	string
captcha_response	formData	Response from captcha widget	No	string

#Responses

Code	Description
201	Generated password reset code
400	Required params are missing
404	User doesn't exist
422	Validation errors

# /api/v2/barong/identity/users/email/confirm_code

#POST

#Description

Confirms an account

#Parameters

Name	Located in	Description	Required	Schema
token	formData	Token from email	Yes	string

#Responses

Code	Description
201	Confirms an account
400	Required params are missing
422	Validation errors

# /api/v2/barong/identity/users/email/generate_code

#POST

#Description

Send confirmations instructions

#Parameters

Name	Located in	Description	Required	Schema
email	formData	Account email	Yes	string
captcha_response	formData	Response from captcha widget	No	string

#Responses

Code	Description
201	Generated verification code
400	Required params are missing
422	Validation errors

# /api/v2/barong/identity/users/register_geetest

#GET

#Description

#Responses

Code	Description
200	Register Geetest captcha

# /api/v2/barong/identity/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
username	formData	User Username	No	string
refid	formData	Referral uid	No	string
captcha_response	formData	Response from captcha widget	No	string
data	formData	Any additional key: value pairs in json string format	No	string

#Responses

Code	Description
201	Creates new user
400	Required params are missing
422	Validation errors

# /api/v2/barong/identity/users/access

#POST

#Description

Creates new whitelist restriction

#Parameters

Name	Located in	Description	Required	Schema
whitelink_token	formData		Yes	string

#Responses

Code	Description
201	Creates new user
400	Required params are missing
422	Validation errors

# /api/v2/barong/identity/sessions

#DELETE

#Description

Destroy current session

#Responses

Code	Description
204	Destroy current session
400	Required params are empty
404	Record is not found

#POST

#Description

Start a new session

#Parameters

Name	Located in	Description	Required	Schema
email	formData		Yes	string
password	formData		Yes	string
captcha_response	formData	Response from captcha widget	No	string
otp_code	formData	Code from Google Authenticator	No	string

#Responses

Code	Description
201	Start a new session
400	Required params are empty
404	Record is not found

# /api/v2/barong/identity/configs

#GET

#Description

Get barong configurations

#Responses

Code	Description
200	Get barong configurations

# /api/v2/barong/identity/version

#GET

#Description

Get barong version

#Responses

Code	Description
200	Get barong version

# /api/v2/barong/identity/time

#GET

#Description

Get server current unix timestamp.

#Responses

Code	Description
200	Get server current unix timestamp.

# /api/v2/barong/identity/ping

#GET

#Description

Test connectivity

#Responses

Code	Description
200	Test connectivity

# /api/v2/barong/identity/password/validate

#POST

#Description

Password strength testing

#Parameters

Name	Located in	Description	Required	Schema
password	formData	User password	Yes	string

#Responses

Code	Description
201	Password strength testing

# /api/v2/barong/public/health/ready

#GET

#Description

Get application readiness status

#Responses

Code	Description
200	Get application readiness status

# /api/v2/barong/public/health/alive

#GET

#Description

Get application liveness status

#Responses

Code	Description
200	Get application liveness status

# /api/v2/barong/public/configs

#GET

#Description

Get barong configurations

#Responses

Code	Description
200	Get barong configurations

# /api/v2/barong/public/version

#GET

#Description

Get barong version

#Responses

Code	Description
200	Get barong version

# /api/v2/barong/public/time

#GET

#Description

Get server current unix timestamp.

#Responses

Code	Description
200	Get server current unix timestamp.

# /api/v2/barong/public/ping

#GET

#Description

Test connectivity

#Responses

Code	Description
200	Test connectivity

# /api/v2/barong/public/password/validate

#POST

#Description

Password strength testing

#Parameters

Name	Located in	Description	Required	Schema
password	formData	User password	Yes	string

#Responses

Code	Description
201	Password strength testing

# /api/v2/barong/public/kyc

#POST

#Description

KYC callback

#Responses

Code	Description
201	KYC callback

# /api/v2/barong/resource/service_accounts/api_keys/{kid }

#PUT

#Description

Updates an api key

#Parameters

Name	Located in	Description	Required	Schema
service_account_uid	formData		Yes	string
kid	path		Yes	string
scope	formData	comma separated scopes	No	string
state	formData	State of API Key. "active" state means key is active and can be used for auth	No	string
totp_code	formData	Code from Google Authenticator	Yes	string

#Responses

Code	Description
200	Updates an api key
400	Required params are empty
401	Invalid bearer token
404	Record is not found
422	Validation errors

#Security

Security Schema	Scopes
BearerToken

#DELETE

#Description

Delete an api key for specific service account

#Parameters

Name	Located in	Description	Required	Schema
service_account_uid	query		Yes	string
kid	path		Yes	string
totp_code	query	Code from Google Authenticator	Yes	string

#Responses

Code	Description
204	Succefully deleted
400	Required params are empty
401	Invalid bearer token
404	Record is not found

#Security

Security Schema	Scopes
BearerToken

# /api/v2/barong/resource/service_accounts/api_keys

#POST

#Description

Create api key for specific service account.

#Parameters

Name	Located in	Description	Required	Schema
service_account_uid	formData		Yes	string
algorithm	formData		Yes	string
scope	formData	comma separated scopes	No	string
totp_code	formData	Code from Google Authenticator	Yes	string

#Responses

Code	Description
201	Create api key for specific service account.
400	Require 2FA and totp code
401	Invalid bearer token

#Security

Security Schema	Scopes
BearerToken

#GET

#Description

List all api keys for specific service account.

#Parameters

Name	Located in	Description	Required	Schema
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
service_account_uid	query		Yes	string

#Responses

Code	Description
200	List all api keys for specific service account.
400	Require 2FA and totp code
401	Invalid bearer token

#Security

Security Schema	Scopes
BearerToken

# /api/v2/barong/resource/service_accounts

#GET

#Description

List all service accounts for current user.

#Responses

Code	Description
200	List all service accounts for current user.
400	Require 2FA and totp code
401	Invalid bearer token

#Security

Security Schema	Scopes
BearerToken

# /api/v2/barong/resource/data_storage

#POST

#Description

Create data storage

#Parameters

Name	Located in	Description	Required	Schema
title	formData		Yes	string
data	formData		Yes	string

#Responses

Code	Description
201	Create data storage
401	Invalid bearer token
422	Validation errors

#Security

Security Schema	Scopes
BearerToken

# /api/v2/barong/resource/api_keys

#GET

#Description

List all api keys for current account.

#Parameters

Name	Located in	Description	Required	Schema
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
200	List all api keys for current account.
400	Require 2FA and totp code
401	Invalid bearer token

#Security

Security Schema	Scopes
BearerToken

#POST

#Description

Create an api key

#Parameters

Name	Located in	Description	Required	Schema
algorithm	formData		Yes	string
scope	formData	comma separated scopes	No	string
totp_code	formData	Code from Google Authenticator	Yes	string

#Responses

Code	Description
201	Create an api key
400	Required params are empty
401	Invalid bearer token
422	Validation errors

#Security

Security Schema	Scopes
BearerToken

# /api/v2/barong/resource/api_keys/{kid }

#DELETE

#Description

Delete an api key

#Parameters

Name	Located in	Description	Required	Schema
kid	path		Yes	string
totp_code	query	Code from Google Authenticator	Yes	string

#Responses

Code	Description
204	Succefully deleted
400	Required params are empty
401	Invalid bearer token
404	Record is not found

#Security

Security Schema	Scopes
BearerToken

#PATCH

#Description

Updates an api key

#Parameters

Name	Located in	Description	Required	Schema
kid	path		Yes	string
scope	formData	comma separated scopes	No	string
state	formData	State of API Key. "active" state means key is active and can be used for auth	No	string
totp_code	formData	Code from Google Authenticator	Yes	string

#Responses

Code	Description
200	Updates an api key
400	Required params are empty
401	Invalid bearer token
404	Record is not found
422	Validation errors

#Security

Security Schema	Scopes
BearerToken

# /api/v2/barong/resource/otp/verify

#POST

#Description

Verify 2FA code

#Parameters

Name	Located in	Description	Required	Schema
code	formData	Code from Google Authenticator	Yes	string

#Responses

Code	Description
201	Verify 2FA code
400	2FA has not been enabled for this account or code is missing
401	Invalid bearer token
422	Validation errors

#Security

Security Schema	Scopes
BearerToken

# /api/v2/barong/resource/otp/disable

#POST

#Description

Disable 2FA

#Parameters

Name	Located in	Description	Required	Schema
code	formData	Code from Google Authenticator	Yes	string

#Responses

Code	Description
201	Disable 2FA
400	2FA has not been enabled for this account or code is missing
401	Invalid bearer token
422	Validation errors

#Security

Security Schema	Scopes
BearerToken

# /api/v2/barong/resource/otp/enable

#POST

#Description

Enable 2FA

#Parameters

Name	Located in	Description	Required	Schema
code	formData	Code from Google Authenticator	Yes	string

#Responses

Code	Description
201	Enable 2FA
400	2FA has been enabled for this account or code is missing
401	Invalid bearer token
422	Validation errors

#Security

Security Schema	Scopes
BearerToken

# /api/v2/barong/resource/otp/generate_qrcode

#POST

#Description

Generate qr code for 2FA

#Responses

Code	Description
201	Generate qr code for 2FA
400	2FA has been enabled for this account
401	Invalid bearer token

#Security

Security Schema	Scopes
BearerToken

# /api/v2/barong/resource/phones/verify

#POST

#Description

Verify a phone

#Parameters

Name	Located in	Description	Required	Schema
phone_number	formData	Phone number with country code	Yes	string
verification_code	formData	Verification code from sms	Yes	string

#Responses

Code	Description
201	Verify a phone
400	Required params are empty
401	Invalid bearer token
404	Record is not found

#Security

Security Schema	Scopes
BearerToken

# /api/v2/barong/resource/phones/send_code

#POST

#Description

Resend activation code

#Parameters

Name	Located in	Description	Required	Schema
phone_number	formData	Phone number with country code	Yes	string
channel	formData	The verification method to use	No	string

#Responses

Code	Description
201	Resend activation code
400	Required params are empty
401	Invalid bearer token
404	Record is not found
422	Validation errors

#Security

Security Schema	Scopes
BearerToken

# /api/v2/barong/resource/phones

#POST

#Description

Add new phone

#Parameters

Name	Located in	Description	Required	Schema
phone_number	formData	Phone number with country code	Yes	string
channel	formData	The verification method to use	No	string

#Responses

Code	Description
201	Add new phone
400	Required params are empty
401	Invalid bearer token
404	Record is not found
422	Validation errors

#Security

Security Schema	Scopes
BearerToken

#GET

#Description

Returns list of user's phones

#Responses

Code	Description
200	Returns list of user's phones
401	Invalid bearer token

#Security

Security Schema	Scopes
BearerToken

# /api/v2/barong/resource/documents

#POST

#Description

Upload a new document for current user

#Parameters

Name	Located in	Description	Required	Schema
doc_type	formData	Document type	Yes	string
doc_number	formData	Document number	Yes	string
upload	formData	Array of Rack::Multipart::UploadedFile	Yes	string
doc_expire	formData	Document expiration date	No	date
doc_category	formData	Category of the submitted document - front/back/selfie etc.	No	string
identificator	formData	Identificator for documents to be supplied together	No	string
metadata	formData	Any additional key: value pairs in json string format	No	string

#Responses

Code	Description
201	Document is uploaded
400	Required params are empty
401	Invalid bearer token
422	Validation errors

#Security

Security Schema	Scopes
BearerToken

#GET

#Description

Return current user documents list

#Responses

Code	Description
200	Return current user documents list
401	Invalid bearer token

#Security

Security Schema	Scopes
BearerToken

# /api/v2/barong/resource/profiles

#PUT

#Description

Update a profile for current_user

#Parameters

Name	Located in	Description	Required	Schema
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
confirm	formData	Profile confirmation	No	boolean

#Responses

Code	Description
200	Update a profile for current_user
401	Invalid bearer token
422	Validation errors

#Security

Security Schema	Scopes
BearerToken

#POST

#Description

Create a profile for current_user

#Parameters

Name	Located in	Description	Required	Schema
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
confirm	formData	Profile confirmation	No	boolean

#Responses

Code	Description
201	Create a profile for current_user
400	Required params are empty
401	Invalid bearer token
409	Profile already exists
422	Validation errors

#Security

Security Schema	Scopes
BearerToken

# /api/v2/barong/resource/profiles/me

#GET

#Description

Return profiles of current resource owner

#Responses

Code	Description
200	Return profiles of current resource owner
401	Invalid bearer token
404	User has no profile

#Security

Security Schema	Scopes
BearerToken

# /api/v2/barong/resource/labels/{key }

#DELETE

#Description

Delete a label with 'public' scope.

#Parameters

Name	Located in	Description	Required	Schema
key	path	Label key.	Yes	string

#Responses

Code	Description
204	Succefully deleted
400	Required params are empty
401	Invalid bearer token
404	Record is not found

#Security

Security Schema	Scopes
BearerToken

#PATCH

#Description

Update a label with 'public' scope.

#Parameters

Name	Located in	Description	Required	Schema
key	path	Label key.	Yes	string
value	formData	Label value.	Yes	string

#Responses

Code	Description
200	Update a label with 'public' scope.
400	Required params are empty
401	Invalid bearer token
404	Record is not found
422	Validation errors

#Security

Security Schema	Scopes
BearerToken

#GET

#Description

Return a label by key.

#Parameters

Name	Located in	Description	Required	Schema
key	path	Label key.	Yes	string

#Responses

Code	Description
200	Return a label by key.
400	Required params are empty
401	Invalid bearer token
404	Record is not found

#Security

Security Schema	Scopes
BearerToken

# /api/v2/barong/resource/labels

#POST

#Description

Create a label with 'public' scope.

#Parameters

Name	Located in	Description	Required	Schema
key	formData	Label key.	Yes	string
value	formData	Label value.	Yes	string

#Responses

Code	Description
201	Create a label with 'public' scope.
400	Required params are empty
401	Invalid bearer token
422	Validation errors

#Security

Security Schema	Scopes
BearerToken

#GET

#Description

List all labels for current user.

#Responses

Code	Description
200	List all labels for current user.
401	Invalid bearer token

#Security

Security Schema	Scopes
BearerToken

# /api/v2/barong/resource/users/password

#PUT

#Description

Sets new account password

#Parameters

Name	Located in	Description	Required	Schema
old_password	formData	Previous account password	Yes	string
new_password	formData	User password	Yes	string
confirm_password	formData	User password	Yes	string

#Responses

Code	Description
201	Changes password
400	Required params are empty
404	Record is not found
422	Validation errors

# /api/v2/barong/resource/users/activity/{topic }

#GET

#Description

Returns user activity

#Parameters

Name	Located in	Description	Required	Schema
topic	path	Topic of user activity. Allowed: [all, password, session, otp]	Yes	string
time_from	query	An integer represents the seconds elapsed since Unix epoch.If set, only activities created after the time will be returned.	No	integer
time_to	query	An integer represents the seconds elapsed since Unix epoch.If set, only activities created before the time will be returned.	No	integer
result	query	Result of user activity. Allowed: [succeed, failed, denied]	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
200	Returns user activity

# /api/v2/barong/resource/users/me

#DELETE

#Description

Blocks current user

#Parameters

Name	Located in	Description	Required	Schema
password	query	Account password	Yes	string
otp_code	query	Code from Google Authenticator	No	string

#Responses

Code	Description
204	Blocks current user

#PUT

#Description

Updates current user data field

#Parameters

Name	Located in	Description	Required	Schema
data	formData	Any additional key: value pairs in json string format	Yes	string

#Responses

Code	Description
200	Updates current user data field

#GET

#Description

Returns current user

#Responses

Code	Description
200	Returns current user

# /api/v2/barong/resource/addresses

#POST

#Description

Upload a new address approval document for current user

#Parameters

Name	Located in	Description	Required	Schema
country	formData	Document type	Yes	string
address	formData	Document number	Yes	string
upload	formData	Array of Rack::Multipart::UploadedFile	Yes	string
city	formData	Document expiration date	Yes	string
postcode	formData	Any additional key: value pairs in json string format	Yes	string

#Responses

Code	Description
201	Document is uploaded
400	Required params are empty
401	Invalid bearer token
422	Validation errors

#Security

Security Schema	Scopes
BearerToken

# Models

#API_V2_Entities_Level

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_Entities_Label

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_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		No
created_at	string		No
updated_at	string		No

#API_V2_Entities_Profile

Name	Type	Description	Required
first_name	string		No
last_name	string	Submasked last name	No
dob	date	Submasked birthday date	No
address	string		No
postcode	string		No
city	string		No
country	string		No
state	string		No
metadata	object	Profile additional fields	No
created_at	string		No
updated_at	string		No

#API_V2_Entities_User

Name	Type	Description	Required
email	string		No
username	string	User username	No
uid	string		No
role	string		No
level	integer		No
otp	boolean	is 2FA enabled for account	No
state	string		No
referral_uid	string	UID of referrer	No
data	string	additional phone and profile info	No

#API_V2_Entities_UserWithProfile

Name	Type	Description	Required
email	string		No
username	string	User username	No
uid	string		No
role	string		No
level	integer		No
otp	boolean	is 2FA enabled for account	No
state	string		No
data	string	additional phone and profile info	No
profiles	API_V2_Entities_Profile		No
referral_uid	string	UID of referrer	No
created_at	string		No
updated_at	string		No

#API_V2_Entities_UserWithKYC

Name	Type	Description	Required
email	string		No
username	string	User username	No
uid	string		No
role	string		No
level	integer		No
otp	boolean		No
state	string		No
data	string	additional phone and profile info	No
profiles	API_V2_Entities_Profile		No
labels	API_V2_Entities_AdminLabelView		No
phones	API_V2_Entities_Phone		No
documents	API_V2_Entities_Document		No
data_storages	API_V2_Entities_DataStorage		No
comments	API_V2_Entities_Comment		No
referral_uid	string	UID of referrer	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_Entities_Phone

Name	Type	Description	Required
country	string		No
number	string	Submasker phone number	No
validated_at	s (g)		No

#API_V2_Entities_Document

Name	Type	Description	Required
upload	string	file url	No
doc_type	string	document type: passport, driver license	No
doc_number	string	Submasker 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	No
title	string	comment title	No
data	string	comment plain text	No
created_at	string		No
updated_at	string		No

#API_V2_Entities_UserWithFullInfo

Name	Type	Description	Required
email	string		No
username	string	User username	No
uid	string		No
role	string		No
level	integer		No
otp	boolean		No
state	string		No
referral_uid	string	UID of referrer	No
csrf_token	string	csrf protection token	No
data	string	additional phone and profile info	No
created_at	string		No
updated_at	string		No
labels	API_V2_Entities_Label		No
phones	API_V2_Entities_Phone		No
profiles	API_V2_Entities_Profile		No
data_storages	API_V2_Entities_DataStorage		No

#API_V2_Entities_Activity

Name	Type	Required
user_ip	string	No
user_agent	string	No
topic	string	No
action	string	No
result	string	No
data	string	No
created_at	string	No

#API_V2_Entities_ServiceAccounts

Name	Type	Required
email	string	No
uid	string	No
role	string	No
level	integer	No
state	string	No
user	API_V2_Entities_User	No
created_at	string	No
updated_at	string	No