# Barong

RESTful API for barong OAuth server

#Version: 2.4.0

# Security

BearerToken

# /admin/levels

#GET

#Description:

Returns array of permissions as paginated collection

#Responses

#Security

# /admin/profiles

#PUT

#Description:

Update a profile for user

#Parameters

#Responses

#Security

#GET

#Description:

Return all profiles

#Parameters

#Responses

#Security

# /admin/restrictions

#DELETE

#Description:

Delete restriction

#Parameters

#Responses

#Security

#PUT

#Description:

Update restriction

#Parameters

#Responses

#Security

#POST

#Description:

Create restriction

#Parameters

#Responses

#Security

#GET

#Description:

Returns array of restrictions as a paginated collection

#Parameters

#Responses

#Security

# /admin/metrics

#GET

#Description:

Returns main statistic in the given time period

#Parameters

#Responses

#Security

# /admin/activities/admin

#GET

#Description:

Returns array of activities as paginated collection

#Parameters

#Responses

#Security

# /admin/activities

#GET

#Description:

Returns array of activities as paginated collection

#Parameters

#Responses

#Security

# /admin/permissions

#PUT

#Description:

Update Permission

#Parameters

#Responses

#Security

#DELETE

#Description:

Deletes permission

#Parameters

#Responses

#Security

#POST

#Description:

Create permission

#Parameters

#Responses

#Security

#GET

#Description:

Returns array of permissions as paginated collection

#Parameters

#Responses

#Security

# /admin/users/data_storage

#DELETE

#Description:

Deletes user's data storage record

#Parameters

#Responses

#Security

# /admin/users/{uid }

#GET

#Description:

Returns user info

#Parameters

#Responses

#Security

# /admin/users/labels

#DELETE

#Description:

Deletes label for user

#Parameters

#Responses

#Security

#PUT

#Description:

Update user label scope

#Parameters

#Responses

#Security

#POST

#Description:

Adds label for user

#Parameters

#Responses

#Security

#GET

#Description:

Returns array of users as paginated collection

#Parameters

#Responses

#Security

# /admin/users/labels/update

#POST

#Description:

Update user label value

#Parameters

#Responses

#Security

# /admin/users/labels/list

#GET

#Description:

Returns existing labels keys and values

#Responses

#Security

# /admin/users/documents/pending

#GET

#Description:

Returns array of users with pending or replaced documents as paginated collection

#Parameters

#Responses

#Security

# /admin/users

#PUT

#Description:

Update user attributes

#Parameters

#Responses

#Security

#GET

#Description:

Returns array of users as paginated collection

#Parameters

#Responses

#Security

# /admin/users/role

#POST

#Description:

Update user role

#Parameters

#Responses

#Security

# /admin/users/update

#POST

#Description:

Update user attributes

#Parameters

#Responses

#Security

# /identity/users/password/confirm_code

#POST

#Description:

Sets new account password

#Parameters

#Responses

# /identity/users/password/generate_code

#POST

#Description:

Send password reset instructions

#Parameters

#Responses

# /identity/users/email/confirm_code

#POST

#Description:

Confirms an account

#Parameters

#Responses

# /identity/users/email/generate_code

#POST

#Description:

Send confirmations instructions

#Parameters

#Responses

# /identity/users/register_geetest

#GET

#Description:

Register Geetest captcha

#Responses

# /identity/users

#POST

#Description:

Creates new user

#Parameters

#Responses

# /identity/sessions

#DELETE

#Description:

Destroy current session

#Responses

#POST

#Description:

Start a new session

#Parameters

#Responses

# /identity/configs

#GET

#Description:

Get barong configurations

#Responses

# /identity/version

#GET

#Description:

Get barong version

#Responses

# /identity/time

#GET

#Description:

Get server current unix timestamp.

#Responses

# /identity/ping

#GET

#Description:

Test connectivity

#Responses

# /identity/password/validate

#POST

#Description:

Password strength testing

#Parameters

#Responses

# /resource/data_storage

#POST

#Description:

Create data storage

#Parameters

#Responses

#Security

# /resource/api_keys

#GET

#Description:

List all api keys for current account.

#Parameters

#Responses

#Security

#POST

#Description:

Create an api key

#Parameters

#Responses

#Security

# /resource/api_keys/{kid }

#DELETE

#Description:

Delete an api key

#Parameters

#Responses

#Security

#PATCH

#Description:

Updates an api key

#Parameters

#Responses

#Security

# /resource/otp/verify

#POST

#Description:

Verify 2FA code

#Parameters

#Responses

#Security

# /resource/otp/disable

#POST

#Description:

Disable 2FA

#Parameters

#Responses

#Security

# /resource/otp/enable

#POST

#Description:

Enable 2FA

#Parameters

#Responses

#Security

# /resource/otp/generate_qrcode

#POST

#Description:

Generate qr code for 2FA

#Responses

#Security

# /resource/phones/verify

#POST

#Description:

Verify a phone

#Parameters

#Responses

#Security

# /resource/phones/send_code

#POST

#Description:

Resend activation code

#Parameters

#Responses

#Security

# /resource/phones

#POST

#Description:

Add new phone

#Parameters

#Responses

#Security

#GET

#Description:

Returns list of user's phones

#Responses

#Security

# /resource/documents

#POST

#Description:

Upload a new document for current user

#Parameters

#Responses

#Security

#GET

#Description:

Return current user documents list

#Responses

#Security

# /resource/profiles

#PUT

#Description:

Update a profile for current_user

#Parameters

#Responses

#Security

#POST

#Description:

Create a profile for current_user

#Parameters

#Responses

#Security

# /resource/profiles/me

#GET

#Description:

Return profiles of current resource owner

#Responses

#Security

# /resource/labels/{key }

#DELETE

#Description:

Delete a label with 'public' scope.

#Parameters

#Responses

#Security

#PATCH

#Description:

Update a label with 'public' scope.

#Parameters

#Responses

#Security

#GET

#Description:

Return a label by key.

#Parameters

#Responses

#Security

# /resource/labels

#POST

#Description:

Create a label with 'public' scope.

#Parameters

#Responses

#Security

#GET

#Description:

List all labels for current user.

#Responses

#Security

# /resource/users/password

#PUT

#Description:

Sets new account password

#Parameters

#Responses

# /resource/users/activity/{topic }

#GET

#Description:

Returns user activity

#Parameters

#Responses

# /resource/users/me

#DELETE

#Description:

Returns current user

#Parameters

#Responses

#GET

#Description:

Returns current user

#Responses

# Models

#Level

#Label

#APIKey

#Profile

#User

#UserWithProfile

#UserWithKYC

#AdminLabelView

#Phone

#Document

#DataStorage

#UserWithFullInfo

#Activity