Get users with a certain role
get
/ec-auth-svc/rest/v1.0/users/role/{role}
Returns all users assigned to a specified global role. The 'role' parameter should match an existing global role name exactly. Each user object includes an ID, first and last name, username, and email address.
Request
Path Parameters
-
role(required): string
The role name to look up users for (case-sensitive, must match an existing role).Example:
APPROVE_LIBRARY_OBJECTS
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Success
Root Schema : schema
Type:
Show Source
array-
Array of:
object DisplayUserDto
User details including name, username, and email address.
Nested Schema : DisplayUserDto
Type:
objectUser details including name, username, and email address.
Show Source
-
emailAddress: string
User's email address.Example:
alice.brown@email.com -
firstName: string
User's first name.Example:
Alice -
id: string
Unique identifier for the user.Example:
1BC29B36F5D64B1B95F4BDBBCEA481BE -
lastName: string
User's last name.Example:
Brown -
userName: string
User's login name.Example:
alicebrown
Examples
400 Response
Bad request
Root Schema : AuthResponse
Type:
objectGeneric API response wrapper containing result, error data, response version and status.
Show Source
-
errorData: object
ErrorResponseData
Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
-
result: object
result
Result data of the API response; actual type depends on the API
-
status: string
(none)
Indicates request success ("success") or failure ("failure").Example:
success -
version: integer
(int32)
Version of the response schema.Example:
1
Nested Schema : ErrorResponseData
Type:
objectStructure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
Show Source
-
details: string
Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.Example:
User role is missing required permission REPORTING_VIEW. Field: userId -
errorCode: string
Application or business-specific error code representing the error type.Example:
REPT_401 -
errorMessage: string
Human-readable error message describing the failure or issue.Example:
Unauthorized: User does not have access to the requested resource
Nested Schema : result
Type:
objectResult data of the API response; actual type depends on the API
Example:
oracle.doceng.json.BetterJsonNull@3565a0f5