GET /api-web/api/idm/search

As of Version

product version 2023 Spring

Request Method GET

Response Format JSON

Description

Retrieves all users and roles matching the search string. (current user, technical users, disabled users and technical roles are filtered out)

>> Specify technical roles

The conditions are specified via the following optional query parameters:

Parameter	Type	Description
`search`	string	A String contained in entity data
`size`	integer($int32)	Maximum number of items for each category to be returned. (default: 10)

Response HTTP status codes:

HTTP Status Code	Meaning
`200 OK`	Successful.
`401 Unauthorized`	Not successful.

Request Example

https://<host>/api-web/api/idm/search?search=test&size=2

no request body

Response Example

200 OK

{
  "users": [
    {
      "username": "test",
      "id": "8f92224b-9901-47ba-b102-62d7a7fc3e98",
      "email": "test@mycompany.com",
      "firstname": "Test",
      "lastname": "User",
      "domain": "dd",
      "tenant": "yuuvistest",
      "authorities": [
        "YUUVIS_DEFAULT"
      ],
      "accountNonExpired": true,
      "accountNonLocked": true,
      "credentialsNonExpired": true,
      "enabled": true
    },
    {
      "username": "test2",
      "id": "3313c0ec-df4f-4f26-8fe8-c00aad2c4a2g",
      "email": "test2@mycompany.com",
      "firstname": "Test",
      "lastname": "Test",
      "domain": "dd",
      "tenant": "yuuvistest",
      "accountNonExpired": true,
      "accountNonLocked": true,
      "credentialsNonExpired": true,
      "enabled": true
    }
  ],
  "roles": [
    {
      "name": "TEST_ROLE",
      "description": "Example role"
    },
    {
      "name": "EXAMPLE_ROLE",
      "description": "Role containing word test in its description"
    }
  ]
}