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

[Deprecated]: Get a user's modes and roles
get

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

Deprecated: Retrieves the list of study mode role assignments for a user in a study, including roles, sites, and depots in version 3.0 of the API. Use /v5.0/authusers/{userid}/studies/{StudyID} instead. The v5 version returns richer details on access mapping and unblinded status, and supports new fields for effective dates per mode. Current version differs by not including granularity at the access mapping or mode assignment levels. Provides expanded details of a user's roles and mode assignments for a particular study, including effective dates and associated site and depot mappings.

Request

Path Parameters
Query Parameters
  • Flag indicating if assignments marked as removed should be included in the response. Use 'Y' to include, 'N' to exclude.
    Default Value: N
    Allowed Values: [ "Y", "N" ]
    Example:
    N

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Success
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : DisplayUserModeStudyRolesListDtoV3
Type: object
Represents a user's mode assignment in v3, including roles, study roles, sites and depots.
Show Source
Example:
{
    "mode":{
        "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."
    },
    "studyRoles":[
        {
            "StudyID":"C66E641816EF4E2798AFFEEDD8D5B1E8",
            "authorizedUserId":"A6706B7CC5904EF79F9D5AE35668D175",
            "modeId":"4A3EDAA8292245C6AA01D8975A7D46E1",
            "StudyRoleID":"68B1C4F7CA2E7C90AFA8B5D8F18A5B4F",
            "roleId":"5E40DF7E44E74FED91B1565DCF4FBC8A",
            "studyRoleName":"LEAD_INVESTIGATOR",
            "studyRoleDesc":"Main PI for the study",
            "studyRoleType":"Primary",
            "studyRoleStatus":"ENABLED",
            "studyRoleCreationType":"auto",
            "effectiveStart":"2021-05-01T08:30:00.000Z",
            "effectiveEnd":"2025-01-01T08:30:00.000Z",
            "versionStart":"2021-04-01T08:30:00.000Z",
            "versionEnd":"2026-01-01T08:30:00.000Z",
            "operationType":"add",
            "userId":"24BADE98851C492A8C5D29DD8F9B1E36",
            "objectVersionNumber":1,
            "softwareVersionNumber":2,
            "reason":"Initial study role assignment",
            "comment":"Added due to auto-enrollment",
            "studyRoleVersion":"v3.5",
            "roles":[
                {
                    "id":"37EFDC494C944E58ADAC8DA952A2C60C",
                    "roleName":"Site User",
                    "roleType":"Application",
                    "roleCategory":"Study",
                    "roleSeq":1,
                    "unblinded":"Y"
                }
            ]
        }
    ],
    "roles":[
        {
            "id":"7D96866A5B1A43388B780C6D15E27ACD",
            "roleName":"MONITOR",
            "roleType":"Application",
            "roleCategory":"Monitor",
            "roleSeq":2,
            "unblinded":"N"
        }
    ],
    "sites":[
        {
            "name":"associatedSites",
            "value":"90C93FDF399E4DED99A0B7EF4E189C32"
        },
        {
            "name":"associatedSites",
            "value":"8188DBB5B5A9486B9767ED7263DA626E"
        },
        {
            "name":"allSites",
            "value":"false"
        }
    ],
    "depots":[
        {
            "name":"associatedDepots",
            "value":"BD561E1A5BD748FFA3505A2B2E493C3A"
        },
        {
            "name":"allDepots",
            "value":"false"
        }
    ]
}
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
Represents an application role and its assignment attributes, including identifiers and display information.
Show Source
Example:
{
    "id":"37EFDC494C944E58ADAC8DA952A2C60C",
    "roleName":"Site User",
    "roleType":"Application",
    "roleCategory":"Study",
    "roleSeq":1,
    "unblinded":"Y"
}
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
Study role assignment details for a user, including all attributes and versioning for v3 API.
Show Source
Example:
{
    "StudyID":"C66E641816EF4E2798AFFEEDD8D5B1E8",
    "authorizedUserId":"A6706B7CC5904EF79F9D5AE35668D175",
    "modeId":"4A3EDAA8292245C6AA01D8975A7D46E1",
    "StudyRoleID":"68B1C4F7CA2E7C90AFA8B5D8F18A5B4F",
    "roleId":"5E40DF7E44E74FED91B1565DCF4FBC8A",
    "studyRoleName":"LEAD_INVESTIGATOR",
    "studyRoleDesc":"Main PI for the study",
    "studyRoleType":"Primary",
    "studyRoleStatus":"ENABLED",
    "studyRoleCreationType":"auto",
    "effectiveStart":"2021-05-01T08:30:00.000Z",
    "effectiveEnd":"2025-01-01T08:30:00.000Z",
    "versionStart":"2021-04-01T08:30:00.000Z",
    "versionEnd":"2026-01-01T08:30:00.000Z",
    "operationType":"add",
    "userId":"24BADE98851C492A8C5D29DD8F9B1E36",
    "objectVersionNumber":1,
    "softwareVersionNumber":2,
    "reason":"Initial study role assignment",
    "comment":"Added due to auto-enrollment",
    "studyRoleVersion":"v3.5",
    "roles":[
        {
            "id":"37EFDC494C944E58ADAC8DA952A2C60C",
            "roleName":"Site User"
        }
    ]
}
Nested Schema : roles
Type: object
Represents an application role and its assignment attributes, including identifiers and display information.
Show Source
Example:
{
    "id":"37EFDC494C944E58ADAC8DA952A2C60C",
    "roleName":"Site User",
    "roleType":"Application",
    "roleCategory":"Study",
    "roleSeq":1,
    "unblinded":"Y"
}

400 Response

Bad request
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