1. REST API for Clinical One Platform
  2. Tasks
  3. Users, Permissions and Roles
  4. Roles
  5. v5.0

Get a user's modes and roles

get

/ec-auth-svc/rest/v5.0/authusers/{userid}/studies/{StudyID}

Retrieves all role, mode, site, and depot assignments for the specified user within a single study. Response returns a full list of user mode assignments with all effective dates, roles, sites, depots, and comprehensive assignment information.

Request

Path Parameters
Query Parameters
  • Flag (Y/N) to include removed assignments in the response.
    Default Value: N
    Allowed Values: [ "Y", "N" ]
    Example:
    N
  • Boolean: whether to include global roles/sub-roles in the results.
    Default Value: true
    Example:
    true

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Comprehensive user study access assignments for all supported modes.
Body ()
Root Schema : DisplayUserStudyAccessDetails
Type: object
Provides a user's last access timestamp and a list of their mode/role/site/depot assignments for a study.
Show Source
Example:
{
    "lastAccess":"2024-10-26T18:41:00.000Z",
    "userStudyModeDetails":[
        {
            "modeName":"active",
            "effectiveStart":"2021-01-01T00:00:00.000Z",
            "effectiveEnd":"2026-01-01T00:00:00.000Z",
            "roles":[
                {
                    "roleId":"A519EF3C2B73455390CFF812AFF61519",
                    "roleName":"Rule Designer"
                },
                {
                    "roleId":"EA0D45A19A6E45CDAAD5F2DB7BD4E104",
                    "roleName":"Site User"
                }
            ],
            "studyRole":{
                "id":"1BC29B36F5D64B1B95F4BDBBCEA481BE",
                "studyRoleName":"LEAD_INVESTIGATOR"
            },
            "sites":{
                "allSites":false,
                "associatedSites":[
                    "946E7D36031941CCA39CD2B2CFF2899B",
                    "FE8925CFA8A74193A2E8D8326E7FEA88"
                ]
            },
            "depots":{
                "allDepots":false,
                "associatedDepots":[
                    "CEE624A4E7EB43059C6AEC24673A288B"
                ]
            }
        }
    ]
}
Nested Schema : userStudyModeDetails
Type: object
Assignment and role details for a user in a specific study mode, including role, studyRole, sites, and depots assignments.
Show Source
Example:
{
    "mode":{
        "modeName":"active",
        "effectiveStart":"2021-01-01T00:00:00.000Z",
        "effectiveEnd":"2026-01-01T00:00:00.000Z"
    },
    "studyRoles":[
        {
            "id":"1BC29B36F5D64B1B95F4BDBBCEA481BE",
            "studyRoleName":"LEAD_INVESTIGATOR"
        }
    ],
    "roles":[
        {
            "roleId":"A519EF3C2B73455390CFF812AFF61519",
            "roleName":"Rule Designer"
        },
        {
            "roleId":"EA0D45A19A6E45CDAAD5F2DB7BD4E104",
            "roleName":"Site User"
        }
    ],
    "sites":[
        {
            "allSites":false,
            "associatedSites":[
                "946E7D36031941CCA39CD2B2CFF2899B",
                "FE8925CFA8A74193A2E8D8326E7FEA88"
            ]
        }
    ],
    "depots":[
        {
            "allDepots":false,
            "associatedDepots":[
                "CEE624A4E7EB43059C6AEC24673A288B"
            ]
        }
    ]
}
Nested Schema : depots
Type: object
Represents a user's mapping to sites or depots for a study/mode.
Show Source
Example:
{
    "name":"associatedSites",
    "value":"90C93FDF399E4DED99A0B7EF4E189C32",
    "StudyID":"45A27BCC19D741C58AF11698753BDE5A",
    "authorizedUserId":"47C0B2D48F2544E6B848FB6923D9531F",
    "mode":"active"
}
Nested Schema : DisplayModeDto
Type: object
Represents a study assignment mode, including metadata and display attributes.
Show Source
Example:
{
    "modeId":"CFA1426E4B9646299E692D9403AC5019",
    "modeName":"active",
    "modeType":"main",
    "modeSeq":1,
    "versionStart":"2023-01-01T09:00:00.000Z",
    "versionEnd":"2024-01-01T09:00:00.000Z",
    "operationType":"add",
    "userId":"BE2376BB5B0D469EBFA78DE98D954327",
    "objectVersionNumber":2,
    "softwareVersionNumber":3,
    "reason":"Scheduled migration",
    "comment":"Automatically assigned at user creation."
}
Nested Schema : roles
Type: object
List of global roles with ID and roleName, assigned to the user in this mode.
Show Source
Nested Schema : sites
Type: object
Represents a user's mapping to sites or depots for a study/mode.
Show Source
Example:
{
    "name":"associatedSites",
    "value":"90C93FDF399E4DED99A0B7EF4E189C32",
    "StudyID":"45A27BCC19D741C58AF11698753BDE5A",
    "authorizedUserId":"47C0B2D48F2544E6B848FB6923D9531F",
    "mode":"active"
}
Nested Schema : studyRoles
Type: object
List of study-level roles assigned to this user in this mode.
Show Source
Nested Schema : roles
Type: array
Show Source
Nested Schema : RoleDtoParams
Type: object
Show Source
Examples

400 Response

Invalid request parameters: missing or malformed user or study ID.
Body ()
Root Schema : AuthResponse
Type: object
Generic API response wrapper containing result, error data, response version and status.
Show Source
Nested Schema : ErrorResponseData
Type: object
Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
Show Source
  • 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
  • Application or business-specific error code representing the error type.
    Example: REPT_401
  • Human-readable error message describing the failure or issue.
    Example: Unauthorized: User does not have access to the requested resource
Nested Schema : result
Type: object
Result data of the API response; actual type depends on the API
Example:
oracle.doceng.json.BetterJsonNull@3565a0f5
Back to Top