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

[Deprecated]: Get all users for a study
get

/ec-auth-svc/rest/v3.0/authstudies/{StudyID}/users

Deprecated: This version of the endpoint is deprecated. Use the v4 API at '/v4.0/authstudies/{StudyID}/users' instead. The v4 endpoint provides paginated, filterable user listings for a study, supports richer search, and returns the latest response structure with more complete user access details. Migrating to the new version ensures all output fields are compliant with the latest schema updates. Prior response structure is less detailed and may omit some child DTO fields.

Request

Path Parameters
Query Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Success
Body ()
Root Schema : DisplayStudyUserListDtoV2
Type: object
Title: DisplayStudyUserListDtoV2
Contains list of users information
Show Source
Nested Schema : users
Type: object
Version 2: Extends DisplayStudyUserDto to include user email and phone information.
Show Source
Example:
{
    "id":"7DC8B36EA5C04E1F9D11C0E5F3FFF789",
    "firstName":"Jane",
    "lastName":"Smith",
    "userName":"jsmith",
    "lastAccess":"2023-12-19T12:42:11.000Z",
    "effectiveStart":"2021-06-11T10:00:00.000Z",
    "effectiveEnd":"2025-09-21T10:00:00.000Z",
    "roles":[
        "Site User",
        "Rule Designer"
    ],
    "sites":{
        "allSites":false,
        "associatedSites":[
            "7DC8B36EA5C04E1F9D11C0E5F3FFF780",
            "6DC8B36EA5C04E1F9D11C0E5F3FFF789"
        ]
    },
    "depots":{
        "allDepots":false,
        "associatedDepots":[
            "7DC8B36EA5W04E1F9D11C0E5F3FFF789"
        ]
    },
    "email":"studyuser@example.com",
    "phone":"+1-222-333-4444"
}
Nested Schema : DisplayDepotNamesListDto
Type: object
Represents a set of depot access information for the user within a study, including all-depots flag and associated depot names.
Show Source
Example:
{
    "allDepots":false,
    "associatedDepots":[
        "DepotA"
    ]
}
Nested Schema : roles
Type: array
Roles assigned to the user within the study.
Show Source
  • Roles assigned to the user within the study.
    Example: ["Rule Designer","Site User"]
Example:
[
    "Rule Designer",
    "Site User"
]
Nested Schema : DisplaySiteNamesListDto
Type: object
Represents a set of site access information for the user within a study, including all-sites flag and associated site names.
Show Source
Example:
{
    "allSites":false,
    "associatedSites":[
        "SiteA",
        "SiteB"
    ]
}
Nested Schema : associatedDepots
Type: array
List of associated depot names for the user.
Show Source
Example:
[
    "DepotA"
]
Nested Schema : associatedSites
Type: array
List of associated site names for the user.
Show Source
  • List of associated site names for the user.
    Example: ["SiteA","SiteB"]
Example:
[
    "SiteA",
    "SiteB"
]

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