Skip to main content

AccountApi

All URIs are relative to http://localhost

MethodHTTP requestDescription
changeAccountPOST /admin/accounts/changeChanges account
createAccountPOST /admin/accounts/createCreates an account
deleteAccountDELETE /admin/accounts/deleteDeletes an account
getAccountsGET /admin/accountsGet all accounts according to the filter
getAccountsCountGET /admin/accounts/countGet account count

changeAccount

AccountModel changeAccount(ChangeAccountRequest)

Changes account

Parameters

NameTypeDescriptionNotes
ChangeAccountRequestChangeAccountRequest

Return type

AccountModel

Authorization

admin-basic, admin-oauth

HTTP request headers

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

createAccount

AccountModel createAccount(CreateAccountRequest)

Creates an account

Parameters

NameTypeDescriptionNotes
CreateAccountRequestCreateAccountRequest

Return type

AccountModel

Authorization

admin-basic, admin-oauth

HTTP request headers

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

deleteAccount

Integer deleteAccount(DeleteAccountsRequest)

Deletes an account

Parameters

NameTypeDescriptionNotes
DeleteAccountsRequestDeleteAccountsRequest

Return type

Integer

Authorization

admin-basic, admin-oauth

HTTP request headers

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

getAccounts

List getAccounts(page, size, accountFieldToOrderBy, fieldsOrder, accountRoles, username)

Get all accounts according to the filter

Parameters

NameTypeDescriptionNotes
pageIntegerPage number[optional] [default to 1]
sizeIntegerPage size[optional] [default to 20]
accountFieldToOrderByStringAccount's field ordered by[optional] [default to USERNAME] [enum: USERNAME, ROLES, UNRECOGNIZED]
fieldsOrderStringOrder in which is ordered[optional] [default to ASC] [enum: ASC, DESC, UNRECOGNIZED]
accountRolesListTypes of roles[optional] [default to null] [enum: UNSPECIFIED, ADMIN, USER, UNRECOGNIZED]
usernameStringAccount's UUID[optional] [default to ]

Return type

List

Authorization

admin-basic, admin-oauth

HTTP request headers

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

getAccountsCount

Integer getAccountsCount(accountFieldToOrderBy, fieldsOrder, accountRoles, username)

Get account count

Parameters

NameTypeDescriptionNotes
accountFieldToOrderByStringAccount's field ordered by[optional] [default to USERNAME] [enum: USERNAME, ROLES, UNRECOGNIZED]
fieldsOrderStringOrder in which is ordered[optional] [default to ASC] [enum: ASC, DESC, UNRECOGNIZED]
accountRolesListTypes of roles[optional] [default to null] [enum: UNSPECIFIED, ADMIN, USER, UNRECOGNIZED]
usernameStringAccount's UUID[optional] [default to ]

Return type

Integer

Authorization

admin-basic, admin-oauth

HTTP request headers

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