Barong

Management API for barong OAuth server

Version: 2.4.0

Security

BearerToken

jwt undefined
Description Bearer Token authentication
Name Authorization
In header

/api/v2/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/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

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/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/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/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 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
state formData No string
Responses
Code Description Schema
201 Imports an existing user API_V2_Management_Entities_UserWithProfile

/api/v2/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/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/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/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/profiles

POST

Description

Imports a profile for user

Parameters
Name Located in Description Required Schema
uid formData User Uid Yes 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
state formData No string
metadata formData No string
Responses
Code Description Schema
201 Imports a profile for user API_V2_Management_Entities_UserWithProfile

/api/v2/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
201 Delete phone number for user

/api/v2/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
201 Create phone number for user

/api/v2/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
201 Get user phone numbers

/api/v2/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/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/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/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/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/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/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 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_Management_Entities_UserWithProfile

Imports a profile for user

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
profiles API_V2_Management_Entities_Profile No
referral_uid string UID of referrer No
created_at string No
updated_at string No

API_V2_Management_Entities_Profile

Name Type Description Required
first_name string No
last_name string Last name 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
created_at string No
updated_at string No

API_V2_Management_Entities_UserWithKYC

Get users and profile information

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
profiles API_V2_Management_Entities_Profile No
labels API_V2_Entities_AdminLabelView No
phones API_V2_Management_Entities_Phone No
documents API_V2_Management_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_Management_Entities_Phone

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

API_V2_Management_Entities_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

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_ServiceAccounts

Get specific service_account information

Name Type Description 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

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_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
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_Phone

Name Type Description Required
country string No
number string Submasker phone number No
validated_at s (g) 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