User search

Find users given a criteria. The criteria object can have multiple fields set in which case they are treated as an "AND"

Request
Security:
vc-security
Request Body schema: application/json
orgId
string
orgIds
required
Array of strings unique
enabled
boolean
locked
boolean
expired
boolean
credentialsExpired
boolean
usingMfa
boolean
sharedSecret
string
lastName
string
firstName
string
roles
required
Array of strings
privileges
required
Array of strings
privilegeRoles
required
Array of strings
username
string
email
string
basic
string

the basic text will be searched against some predefined fields

authenticator
string
authenticators
required
Array of strings
authenticatorInclude
boolean
Default: true
startTimestamp
string <date-time>

Start timestamp for successful login search

endTimestamp
string <date-time>

End timestamp for successful login search

Responses
200

OK

400

Bad Request. The request parameters (or body) were malformed or invalid. Fix the issues with the request and try again.

401

Unauthorized request. Make sure token was included and is valid and try again.

403

Forbidden. You are not permitted to access the requested resource.

post/user-service/v1/user/search
Request samples
application/json
{
  • "orgId": "string",
  • "orgIds": [
    ],
  • "enabled": true,
  • "locked": true,
  • "expired": true,
  • "credentialsExpired": true,
  • "usingMfa": true,
  • "sharedSecret": "string",
  • "lastName": "string",
  • "firstName": "string",
  • "roles": [
    ],
  • "privileges": [
    ],
  • "privilegeRoles": [
    ],
  • "username": "string",
  • "email": "string",
  • "basic": "string",
  • "authenticator": "string",
  • "authenticators": [
    ],
  • "authenticatorInclude": true,
  • "startTimestamp": "2019-08-24T14:15:22Z",
  • "endTimestamp": "2019-08-24T14:15:22Z"
}
Response samples
application/json
[
  • {
    }
]