Get All Users Info
Returns the users and groups known to Installer, whether defined locally or
discovered through a configured LDAP identity source. Use the role and user_type
filters to narrow results, for example to find every user who holds the auditor role.
Return only entries whose name contains this value (case-insensitive, partial match).
Return only entries of these user types, e.g. restrict results to LOCAL_USER.
Offset pagination parameter used to exclude from a response the first N items of a resource collection. Combine the offset and the page_size options to request a particular set or page of items.
Number of records to be returned in the API request from the provided offset
True, if the list of records returned need to be sorted in ascending order, false otherwise.
The parameter name on which to sort the list of records. Only top-level parameters in the returned list of records will be supported. If not provided, system will define the parameter by which results are sorted.
The list of matching users and groups was retrieved successfully.
{
"offset": 0,
"number_of_results": 1,
"total_result_count": 1,
"total_pages": 1,
"sort_ascending": true,
"sort_by": "name",
"results": [
{
"name": "admin",
"display_name": "Administrator",
"user_type": "LOCAL_USER",
"password_status": "ACTIVE",
"roles": [
{
"role": "ENTERPRISE_ADMIN",
"display_name": "Enterprise Admin"
}
]
}
]
}Bad Request
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Unauthorized
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Forbidden
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Precondition Failed
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Precondition Required
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Too Many Requests
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
4XX and 5XX type errors with appropriate message
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
curl -H 'Authorization: <value>' https://{api_host}/https://{api_host}:{port}/lh-appliance/iam/users