Skip to main content

ManagementApi

All URIs are relative to http://localhost

MethodHTTP requestDescription
getDefaultPropertiesGET /user/management/default-propertiesGets default properties of biometric operations
getManagementInfoGET /user/management/infoGets information and vital parameters of management
getMeGET /user/management/meGets information about the authorization from the session cookie
loginPOST /login
logoutPOST /logout
oauth2TokenPOST /oauth2/tokenToken endpoint

getDefaultProperties

List getDefaultProperties()

Gets default properties of biometric operations

Parameters

This endpoint does not need any parameter.

Return type

List

Authorization

user-basic, user-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

No authorization required

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

user-basic, user-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

NameTypeDescriptionNotes
passwordString[default to null]
usernameString[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

NameTypeDescriptionNotes
client_idStringClient ID[optional] [default to null]
client_secretStringClient Secret (only for client_credentials)[optional] [default to null]
codeStringAuthorization code (only for authorization_code flow)[optional] [default to null]
code_verifierStringPKCE code verifier (authorization_code flow)[optional] [default to null]
grant_typeStringOAuth2 grant type[optional] [default to client_credentials]
redirect_uriStringRedirect URI (authorization_code flow)[optional] [default to null]
scopeStringRequested 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, /