Get all active and inactive users per study
get
/ec-auth-svc/rest/v1.0/authusers/study/{StudyID}
Gets the list of users assigned to a specific study. Use StudyID to select the study, and optionally exclude system users from the result. All user objects include attributes (ID, userName, email, roles, status, etc.).
Request
Path Parameters
-
StudyID(required): string(uuid)
Unique identifier for the study to filter users.Example:
DDF00A816BED40188DF769B206AD0EC6
Query Parameters
-
excludeSystemUsers: boolean
If true, users created by system processes are excluded.Default Value:
falseExample:false
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 DisplayUserDto2
User details extending DisplayUserDto with versioning and auditing fields.
Nested Schema : DisplayUserDto2
Type:
objectUser details extending DisplayUserDto with versioning and auditing fields.
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 -
objectVersionNumber: number
(double)
Version number for the user object.Example:
2 -
operationType: string
Type of operation performed (e.g., CREATE, UPDATE, DELETE).Example:
CREATE -
softwareVersionNumber: number
(double)
Version number for the software.Example:
1.5 -
userName: string
User's login name.Example:
alicebrown -
versionEnd: string
(date-time)
Timestamp for when this version of the user record ended.Example:
2024-01-01T10:00:00Z -
versionStart: string
(date-time)
Timestamp for when this version of the user record started.Example:
2023-01-01T10:00:00Z
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