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

Get all users for a study mode

post

/ec-auth-svc/rest/v1.0/authstudies/{StudyID}/userdetails

Retrieves all the users that belong to a study mode.

Request

Path Parameters
Query Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : depots
Type: object
Depots data to filter the users
Show Source
Example:
{
    "names":[
        "DepotA"
    ]
}
Nested Schema : sites
Type: object
Sites data to filter the users
Show Source
Example:
{
    "ids":[
        "123F0B1426C11EE90C31234567890AAA"
    ]
}
Nested Schema : studyRoles
Type: array
List of study role UUIDs
Show Source
Example:
[
    "AF73A2EEA90B4E9394CE6CB40B5BC66E"
]
Nested Schema : studyRoleTypes
Type: array
List of study role types
Show Source
Example:
[
    "PrincipalInvestigator"
]
Nested Schema : depotIds
Type: array
Show Source
Nested Schema : siteIds
Type: array
Show Source
Back to Top

Response

Supported Media Types

200 Response

Success
Body ()
Root Schema : DisplayStudyUserListDtoV3
Type: object
Paginated and detailed response object representing a list of study users, including overall count and returned slice, for API v4 and similar endpoints. Each user entry is deeply expanded, including all modes, role assignments, sites, and depots, as required by downstream consumers.
Show Source
Nested Schema : users
Type: object
Full representation of a user returned in the study-users APIs. Covers all identifiers, contact, temporal, and role/mode/assignment details. See the 'modes' property for full expansion of all site/role/depot assignments.
Show Source
Example:
[
    {
        "id":"B29BC40C838C42C5972D35880BEBB403",
        "firstName":"Alice",
        "lastName":"Lee",
        "userName":"alice.lee",
        "email":"alice.lee@fakemail.org",
        "phone":"+1-101-202-3030",
        "lastAccess":"2024-02-14T18:00:00.000Z",
        "effectiveStart":"2023-01-01T00:00:00.000Z",
        "effectiveEnd":"2025-12-31T23:59:59.000Z",
        "modes":[
            {
                "modeName":"active",
                "roles":[
                    {
                        "id":"AABBCCDDEEFF112233445566778899AA",
                        "roleName":"Site Coordinator"
                    }
                ],
                "studyRole":[
                    {
                        "id":"D0F1E2C3B4A5968775CCEE8855229966",
                        "studyRoleName":"Monitor",
                        "versionStart":"2021-01-01T00:00:00.000Z",
                        "versionEnd":"2024-12-31T23:59:59.000Z"
                    }
                ],
                "sites":{
                    "allSites":false,
                    "siteIds":[
                        "817F1E2B3D4C5678A1928833BFA40721"
                    ]
                },
                "depots":{
                    "allDepots":false,
                    "names":[
                        "DepotZ"
                    ]
                }
            }
        ]
    }
]
Nested Schema : modes
Type: object
All assignment information for a user in a given mode (e.g., active, training) including roles, study roles, mapped sites and mapped depots. This object is a key part of user-level responses.
Show Source
  • DisplayDepotsListDtoV2
    Collection representing the set of depots mapped for a user/mode. Includes global/all flag and list of detailed depot associations.
  • Study mode for these assignments (e.g., active, training, etc.)
    Example: active
  • roles
    User role assignment within a study mode. Contains role reference, display label, and (if set) a mapped StudyRoleID. UUIDs are always uppercase.
  • DisplaySitesListDtoV2
    Collection representing the set of sites mapped for a user/mode. Includes global/all flag and list of detailed site associations.
  • studyRole
    Single study role assignment in a mode. Includes primary ID, display label, and version validity dates (inherited from DisplayAuthBaseDto).
Example:
[
    {
        "modeName":"active",
        "roles":[
            {
                "id":"F0DEEFCB66A14C2AA0699165055A38C1",
                "roleName":"Data Manager"
            }
        ],
        "studyRole":[
            {
                "id":"1A9CF1A460CD440CA62B6F9EA258F968",
                "studyRoleName":"Investigator",
                "versionStart":"2021-07-01T00:00:00.000Z",
                "versionEnd":"2024-01-31T23:59:59.000Z"
            }
        ],
        "sites":{
            "allSites":false,
            "siteIds":[
                "21F6B67B398A4977A19964FF7B7A68FD"
            ]
        },
        "depots":{
            "allDepots":true,
            "names":[
            ]
        }
    }
]
Nested Schema : DisplayDepotsListDtoV2
Type: object
Collection representing the set of depots mapped for a user/mode. Includes global/all flag and list of detailed depot associations.
Show Source
Example:
{
    "allDepots":true,
    "names":[
    ]
}
Nested Schema : roles
Type: object
User role assignment within a study mode. Contains role reference, display label, and (if set) a mapped StudyRoleID. UUIDs are always uppercase.
Show Source
Example:
[
    {
        "id":"F0DEEFCB66A14C2AA0699165055A38C1",
        "roleName":"Data Manager"
    }
]
Nested Schema : DisplaySitesListDtoV2
Type: object
Collection representing the set of sites mapped for a user/mode. Includes global/all flag and list of detailed site associations.
Show Source
Example:
{
    "allSites":false,
    "siteIds":[
        "21F6B67B398A4977A19964FF7B7A68FD"
    ]
}
Nested Schema : studyRole
Type: object
Single study role assignment in a mode. Includes primary ID, display label, and version validity dates (inherited from DisplayAuthBaseDto).
Show Source
Example:
[
    {
        "id":"1A9CF1A460CD440CA62B6F9EA258F968",
        "studyRoleName":"Investigator",
        "versionStart":"2021-07-01T00:00:00.000Z",
        "versionEnd":"2024-01-31T23:59:59.000Z"
    }
]
Nested Schema : associatedDepots
Type: object
Represents a single depot facility mapped to the user/mode assignment. UUID is always uppercase.
Show Source
Example:
[
    {
        "depotId":"7A01356CE45847A0B2B4E5D7DDA18942",
        "name":"Vault"
    }
]
Nested Schema : associatedSites
Type: object
Represents a single site mapped to user/mode assignments. UUID is always uppercase.
Show Source
Example:
[
    {
        "siteId":"2BC6B6F87E774B24A20C769C2B80B7F5",
        "name":"SiteA"
    }
]

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