UserManagementServiceImpl

string

The Spring bean identifier containing the service being called.userManagementServiceImpl

string

default:"PROTOTYPE"

Bean scope. Use PROTOTYPE for service calls.

string

The public service method name shown in the signature below.

object[]

The method argument array. Each argument is passed as an object with index 0, 1, and so on; the value must match the Java parameter type.

Headers

POST /api/v1/bean/request
Content-Type: application/json
Lang-Context: en
Site-Context: my-site
Authorization: Bearer <token>

Send Lang-Context and Site-Context with every request. For protected methods, send the JWT in the Authorization header as Bearer <token>. Access: USER or ADMIN. Bearer Token: required.

GUEST — unauthenticated users; only whitelist services are available.
USER — authentication is required; methods with USER checks are available.
ADMIN — full access to public methods of all services.
If a method checks a role internally, GUEST may receive null.

Methods

UserRepository

Argument	Type	Description
—	—	This method does not accept arguments.

getRepository

{
  "beanId": "userManagementServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getRepository",
  "args": []
}

Deque<Map<String, Object>>

Argument	Type	Description
`requestJson`	`String`	Passed through `args[0].0`.

getPaginationFilter

{
  "beanId": "userManagementServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getPaginationFilter",
  "args": [
    {
      "0": null
    }
  ]
}

LinkedHashSet<User>

Argument	Type	Description
`requestJson`	`String`	Passed through `args[0].0`.

searchUsers

{
  "beanId": "userManagementServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchUsers",
  "args": [
    {
      "0": null
    }
  ]
}

Page<User>

Argument	Type	Description
`requestJson`	`String`	Passed through `args[0].0`.

searchUsersPaged

{
  "beanId": "userManagementServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchUsersPaged",
  "args": [
    {
      "0": null
    }
  ]
}

UserPrincipal

Argument	Type	Description
—	—	This method does not accept arguments.

getPrincipal

{
  "beanId": "userManagementServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getPrincipal",
  "args": []
}

User

Argument	Type	Description
—	—	This method does not accept arguments.

getLoggedUser

{
  "beanId": "userManagementServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getLoggedUser",
  "args": []
}

boolean

Argument	Type	Description
—	—	This method does not accept arguments.

isSuperUser

{
  "beanId": "userManagementServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "isSuperUser",
  "args": []
}

boolean

Argument	Type	Description
—	—	This method does not accept arguments.

isLogged

{
  "beanId": "userManagementServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "isLogged",
  "args": []
}

boolean

Argument	Type	Description
—	—	This method does not accept arguments.

isNotLogged

{
  "beanId": "userManagementServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "isNotLogged",
  "args": []
}

List<User>

Argument	Type	Description
`query`	`String`	Passed through `args[0].0`.
`from`	`int`	Passed through `args[1].1`.
`to`	`int`	Passed through `args[2].2`.

searchUsers

{
  "beanId": "userManagementServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchUsers",
  "args": [
    {
      "0": null,
      "1": null,
      "2": null
    }
  ]
}

Optional<User>

Argument	Type	Description
`userAsMap`	`LinkedHashMap<String, Object>`	Passed through `args[0].0`.

createUser

Example JSON request object:

{
    "id":  null,
    "username":  null,
    "password":  null,
    "savedPassword":  null,
    "fallIntoObjects":  null,
    "active":  false,
    "roles":  null,
    "permissions":  null
}

Request:

{
  "beanId": "userManagementServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "createUser",
  "args": [
    {
      "0": null
    }
  ]
}

Optional<User>

Argument	Type	Description
`userAsMap`	`LinkedHashMap<String, Object>`	Passed through `args[0].0`.

saveUser

Example JSON request object:

{
    "id":  null,
    "username":  null,
    "password":  null,
    "savedPassword":  null,
    "fallIntoObjects":  null,
    "active":  false,
    "roles":  null,
    "permissions":  null
}

Request:

{
  "beanId": "userManagementServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "saveUser",
  "args": [
    {
      "0": null
    }
  ]
}

void

Argument	Type	Description
`userId`	`String`	Passed through `args[0].0`.

removeUserAndClean

{
  "beanId": "userManagementServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeUserAndClean",
  "args": [
    {
      "0": null
    }
  ]
}

void

Argument	Type	Description
`userIds`	`ArrayList<String>`	Passed through `args[0].0`.

removeUsersByIds

{
  "beanId": "userManagementServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeUsersByIds",
  "args": [
    {
      "0": null
    }
  ]
}

Optional<User>

Argument	Type	Description
`userId`	`String`	Passed through `args[0].0`.

revertPasswordToSaved

{
  "beanId": "userManagementServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "revertPasswordToSaved",
  "args": [
    {
      "0": null
    }
  ]
}

void

Argument	Type	Description
`userId`	`String`	Passed through `args[0].0`.

saveSavedPassword

{
  "beanId": "userManagementServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "saveSavedPassword",
  "args": [
    {
      "0": null
    }
  ]
}

boolean

Argument	Type	Description
—	—	This method does not accept arguments.

isUserPermissionAll

{
  "beanId": "userManagementServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "isUserPermissionAll",
  "args": []
}

boolean

Argument	Type	Description
—	—	This method does not accept arguments.

isUserPermissionApplication

{
  "beanId": "userManagementServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "isUserPermissionApplication",
  "args": []
}

Client integration

Clients

Services

REST API

Headers

Methods

getRepository

getPaginationFilter

searchUsers

searchUsersPaged

getPrincipal

getLoggedUser

isSuperUser

isLogged

isNotLogged

searchUsers

createUser

saveUser

removeUserAndClean

removeUsersByIds

revertPasswordToSaved

saveSavedPassword

isUserPermissionAll

isUserPermissionApplication

​Headers

​Methods

​getRepository

​getPaginationFilter

​searchUsers

​searchUsersPaged

​getPrincipal

​getLoggedUser

​isSuperUser

​isLogged

​isNotLogged

​searchUsers

​createUser

​saveUser

​removeUserAndClean

​removeUsersByIds

​revertPasswordToSaved

​saveSavedPassword

​isUserPermissionAll

​isUserPermissionApplication

Headers

Methods

getRepository

getPaginationFilter

searchUsers

searchUsersPaged

getPrincipal

getLoggedUser

isSuperUser

isLogged

isNotLogged

searchUsers

createUser

saveUser

removeUserAndClean

removeUsersByIds

revertPasswordToSaved

saveSavedPassword

isUserPermissionAll

isUserPermissionApplication