ManagementApi

All URIs are relative to http://localhost

Method	HTTP request	Description
deleteSetting	DELETE /admin/management/setting	Deletes one setting that match the key
getClusterStatus	GET /admin/management/cluster/status	Gets cluster status
getDefaultProperties	GET /admin/management/default-properties	Gets default properties of biometric operations
getManagementInfo	GET /admin/management/info	Gets information and vital parameters of management
getMe	GET /admin/management/me	Gets information about the authorization from the session cookie
getSetting	GET /admin/management/setting	Gets one setting that match the key
getSettings	GET /admin/management/settings	Gets all settings saved in management
getSettingsByKey	GET /admin/management/settings/key	Gets all settings that starts with the prefix
login	POST /login
logout	POST /logout
oauth2Token	POST /oauth2/token	Token endpoint
resetSettings	POST /admin/management/settings/reset	Resets all default settings.
setSetting	POST /admin/management/settings	Saves or deletes the setting with specified key
truncateDatabase	DELETE /admin/management/database/clear-db	Clears all database, except for flyaway schema version and settings

deleteSetting

deleteSetting(key)

Deletes one setting that match the key

Parameters

Name	Type	Description	Notes
key	String	Key for setting to be deleted.	[default to null]

Return type

null (empty response body)

Authorization

admin-basic, admin-oauth

HTTP request headers

• Content-Type: Not defined
• Accept: /

getClusterStatus

DbClusterStatus getClusterStatus()

Gets cluster status

Parameters

This endpoint does not need any parameter.

Return type

DbClusterStatus

Authorization

admin-basic, admin-oauth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, /

getDefaultProperties

List getDefaultProperties()

Gets default properties of biometric operations

Parameters

This endpoint does not need any parameter.

Return type

List

Authorization

admin-basic, admin-oauth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, /

getManagementInfo

Map getManagementInfo()

Gets information and vital parameters of management

Parameters

This endpoint does not need any parameter.

Return type

Map

Authorization

admin-basic, admin-oauth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, /

getMe

MeResponse getMe()

Gets information about the authorization from the session cookie

Parameters

This endpoint does not need any parameter.

Return type

MeResponse

Authorization

admin-basic, admin-oauth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, /

getSetting

String getSetting(key)

Gets one setting that match the key

Parameters

Name	Type	Description	Notes
key	String	Prefix for setting to be fetched.	[default to null]

Return type

String

Authorization

admin-basic, admin-oauth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, /

getSettings

Map getSettings()

Gets all settings saved in management

Parameters

This endpoint does not need any parameter.

Return type

Map

Authorization

admin-basic, admin-oauth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, /

getSettingsByKey

Map getSettingsByKey(key)

Gets all settings that starts with the prefix

Parameters

Name	Type	Description	Notes
key	String	Prefix for settings to be fetched.	[default to null]

Return type

Map

Authorization

admin-basic, admin-oauth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, /

login

LoginResponse login(password, username)

Authenticates a user using username and password. Returns auth type and granted authorities.

Parameters

Name	Type	Description	Notes
password	String		[default to null]
username	String		[default to null]

Return type

LoginResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: application/x-www-form-urlencoded
• Accept: application/json, /

logout

logout()

Logs out the current user and invalidates the session. Clears authentication cookies.

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: /

oauth2Token

AccessTokenResponse oauth2Token(client_id, client_secret, code, code_verifier, grant_type, redirect_uri, scope)

Token endpoint

Token endpoint for both client_credentials and authorization_code (PKCE) flows.

Parameters

Name	Type	Description	Notes
client_id	String	Client ID	[optional] [default to null]
client_secret	String	Client Secret (only for client_credentials)	[optional] [default to null]
code	String	Authorization code (only for authorization_code flow)	[optional] [default to null]
code_verifier	String	PKCE code verifier (authorization_code flow)	[optional] [default to null]
grant_type	String	OAuth2 grant type	[optional] [default to client_credentials]
redirect_uri	String	Redirect URI (authorization_code flow)	[optional] [default to null]
scope	String	Requested scope (only for client_credentials)	[optional] [default to null]

Return type

AccessTokenResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: application/x-www-form-urlencoded
• Accept: application/json, /

resetSettings

resetSettings()

Resets all default settings.

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

admin-basic, admin-oauth

HTTP request headers

• Content-Type: Not defined
• Accept: /

setSetting

setSetting(key, value)

Saves or deletes the setting with specified key

Creates a new setting if the current key do not exists in the database. If the key already exists in the database its value will be updated. If the key exists in the database and the new value is null, the key will be deleted.

Parameters

Name	Type	Description	Notes
key	String	Setting's key to be saved.	[default to null]
value	String	Setting's value to be saved.	[optional] [default to null]

Return type

null (empty response body)

Authorization

admin-basic, admin-oauth

HTTP request headers

• Content-Type: Not defined
• Accept: /

truncateDatabase

truncateDatabase()

Clears all database, except for flyaway schema version and settings

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

admin-basic, admin-oauth

HTTP request headers

• Content-Type: Not defined
• Accept: /