Documentation

API Docs Technical Docs User Guides Changelogs

Versions

# Barong

Management API for barong OAuth server

#Version: 2.3.38

# Security

BearerToken

jwt	undefined
Description	Bearer Token authentication
Name	Authorization
In	header

# /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	Schema
201	Delete a label with 'private' scope	Label

# /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
replace	formData	When true label will be created if not exist	No	boolean

#Responses

Code	Description	Schema
200	Update a label with 'private' scope	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

#Responses

Code	Description	Schema
201	Create a label with 'private' scope and assigns to users	Label

# /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	Label

# /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
from	formData	An integer represents the seconds elapsed since Unix epoch.If set, only labels FROM the time will be retrieved.	No	integer
to	formData	An integer represents the seconds elapsed since Unix epoch.If set, only labels 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 1000).	No	integer

#Responses

Code	Description	Schema
201	Get all labels assigned to users	Label

# /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
phone	formData		No	string
first_name	formData		No	string
last_name	formData		No	string
dob	formData	Birthday date	No	date
address	formData		No	string
postcode	formData		No	string
city	formData		No	string
country	formData		No	string

#Responses

Code	Description	Schema
201	Imports an existing user	UserWithProfile

# /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

#Responses

Code	Description	Schema
201	Creates new user	UserWithProfile

# /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 users FROM the time will be retrieved.	No	integer
to	formData	An integer represents the seconds elapsed since Unix epoch.If set, only users 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 1000).	No	integer

#Responses

Code	Description	Schema
201	Returns array of users as collection	User

# /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	UserWithProfile

# /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

# /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	Schema
201	Push documents to barong DB	UserWithProfile

# /timestamp

#POST

#Description:

Returns server time in seconds since Unix epoch.

#Responses

Code	Description
201	Returns server time in seconds since Unix epoch.

# Models

#Label

Get all labels assigned 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

#UserWithProfile

Push documents to barong DB

Name	Type	Description	Required
email	string		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
profile	Profile		No
referral_uid	string	UID of referrer	No
created_at	string		No
updated_at	string		No

#Profile

Name	Type	Description	Required
first_name	string		No
last_name	string		No
dob	date	Birthday date	No
address	string		No
postcode	string		No
city	string		No
country	string		No
state	string		No
metadata	object	Profile additional fields	No

#User

Returns array of users as collection

Name	Type	Description	Required
email	string		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

#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

#UserWithFullInfo

Name	Type	Description	Required
email	string		No
uid	string		No
role	string		No
level	integer		No
otp	boolean		No
state	string		No
referral_uid	string	UID of referrer	No
data	string	additional phone and profile info	No
created_at	string		No
updated_at	string		No
labels	Label		No
phones	Phone		No
profile	Profile		No

#Phone

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

#UserWithKYC

Name	Type	Description	Required
email	string		No
uid	string		No
role	string		No
level	integer		No
otp	boolean		No
state	string		No
data	string	additional phone and profile info	No
profile	Profile		No
labels	Label		No
phones	Phone		No
documents	Document		No
referral_uid	string	UID of referrer	No
created_at	string		No
updated_at	string		No

#Document

Name	Type	Description	Required
upload	string	file url	No
doc_type	string	document type: passport, driver license	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