[Deprecated]: Get list of roles for a study
get
/ec-auth-svc/rest/v2.0/authroles/{StudyID}
Deprecated: Retrieves roles for a specific study and study role type. Use /v3.0/authroles/{StudyID} for improved schema including category, subcategory, unblinded, objectVersionNumber. v3 endpoint adds new properties and enhances response structure.
Request
Path Parameters
-
StudyID(required): string(uuid)
Unique identifier for the study.Example:
E21ECE85DDDA4F37B2A88C2327AE315D
Query Parameters
-
studyRoleType(required): string
Role type for which to retrieve roles.Example:
Design
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 DisplayRoleDtoV2
Represents a user role in v2 with additional details.
Nested Schema : DisplayRoleDtoV2
Type:
objectRepresents a user role in v2 with additional details.
Show Source
-
id(required): string
Unique identifier for the user roleExample:
1BC29B36F5D64B1B95F4BDBBCEA481BE -
objectVersionNumber(required): integer
(int32)
Version number for optimistic lockingExample:
1 -
roleCategory(required): string
Category of the roleExample:
Sponsor -
roleName(required): string
The display name of the roleExample:
Monitor -
roleSubCategory: string
Sub category of the role if availableExample:
Central -
roleType(required): string
Type of the role (e.g., Runtime, Design)Example:
Runtime -
unblinded: string
Indicates if the role is unblinded (true/false)Example:
true
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