REST API for Clinical One Platform

~~[Deprecated]: Get all users for a study~~

get

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

Deprecated: Use latest version instead. Retrieves all the users that belong to a study.

Request

Path Parameters

StudyID(required): string
Study ID
Example:
```
ABE31741A0E945F6B827048B279F2F19
```

Query Parameters

firstResult: integer(int32)
Offset from where the results should be retrieved
Example:
```
1
```
rowsToReturn: integer(int32)
Limit for the number of results to be returned
Example:
```
5
```
searchString: string
Given name or family name of the user to filter the results.
Example:
```
john
```
viewMode: string
Mode of the study. Accepts active, test, or training

Allowed Values: [ "design", "test", "training", "active", "all" ]
Example:
```
design
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : DisplayStudyUserListDtoV2

Type: object

Title: DisplayStudyUserListDtoV2

Contains list of users information

Show Source

firstUserReturned: integer (int32)

Index of the first user returned in this page.

Example: 1
users: object users

Version 2: Extends DisplayStudyUserDto to include user email and phone information.
usersFound: integer (int32)

The total number of users found matching the query.

Example: 2
usersReturned: integer (int32)

How many users are present in this response.

Example: 2

{
    "title":"DisplayStudyUserListDtoV2",
    "type":"object",
    "properties":{
        "usersFound":{
            "type":"integer",
            "description":"The total number of users found matching the query.",
            "format":"int32",
            "example":2
        },
        "firstUserReturned":{
            "type":"integer",
            "description":"Index of the first user returned in this page.",
            "format":"int32",
            "example":1
        },
        "usersReturned":{
            "type":"integer",
            "description":"How many users are present in this response.",
            "format":"int32",
            "example":2
        },
        "users":{
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"Unique identifier of the user within the study.",
                    "format":"uuid"
                },
                "firstName":{
                    "type":"string",
                    "description":"User's first name.",
                    "example":"John"
                },
                "lastName":{
                    "type":"string",
                    "description":"User's last name.",
                    "example":"Doe"
                },
                "email":{
                    "type":"string",
                    "description":"User's email address.",
                    "format":"email",
                    "example":"studyuser@example.com"
                },
                "phone":{
                    "type":"string",
                    "description":"User's phone number.",
                    "example":"+1-222-333-4444"
                },
                "userName":{
                    "type":"string",
                    "description":"Username used for authentication.",
                    "example":"jdoe"
                },
                "lastAccess":{
                    "type":"string",
                    "description":"Timestamp (ISO8601/Z) when user last accessed the study.",
                    "format":"date-time",
                    "example":"2022-06-20T13:51:51Z"
                },
                "effectiveStart":{
                    "type":"string",
                    "description":"Effective start date for user's study access (ISO8601/Z).",
                    "format":"date-time",
                    "example":"2021-01-17T01:00:00Z"
                },
                "effectiveEnd":{
                    "type":"string",
                    "description":"Effective end date for user's study access (ISO8601/Z).",
                    "format":"date-time",
                    "example":"2025-01-17T01:00:00Z"
                },
                "roles":{
                    "type":"array",
                    "description":"Roles assigned to the user within the study.",
                    "example":[
                        "Rule Designer",
                        "Site User"
                    ],
                    "items":{
                        "type":"string",
                        "description":"Roles assigned to the user within the study.",
                        "example":"[\"Rule Designer\",\"Site User\"]"
                    }
                },
                "sites":{
                    "$ref":"#/components/schemas/DisplaySiteNamesListDto"
                },
                "depots":{
                    "$ref":"#/components/schemas/DisplayDepotNamesListDto"
                }
            },
            "description":"Version 2: Extends DisplayStudyUserDto to include user email and phone information.",
            "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"
            }
        }
    },
    "description":"Contains list of users information"
}

Nested Schema : users

Type: object

Version 2: Extends DisplayStudyUserDto to include user email and phone information.

Show Source

depots: object DisplayDepotNamesListDto

Represents a set of depot access information for the user within a study, including all-depots flag and associated depot names.
effectiveEnd: string (date-time)

Effective end date for user's study access (ISO8601/Z).

Example: 2025-01-17T01:00:00Z
effectiveStart: string (date-time)

Effective start date for user's study access (ISO8601/Z).

Example: 2021-01-17T01:00:00Z
email: string (email)

User's email address.

Example: studyuser@example.com
firstName: string

User's first name.

Example: John
id: string (uuid)

Unique identifier of the user within the study.
lastAccess: string (date-time)

Timestamp (ISO8601/Z) when user last accessed the study.

Example: 2022-06-20T13:51:51Z
lastName: string

User's last name.

Example: Doe
phone: string

User's phone number.

Example: +1-222-333-4444
roles: array roles

Roles assigned to the user within the study.
sites: object DisplaySiteNamesListDto

Represents a set of site access information for the user within a study, including all-sites flag and associated site names.
userName: string

Username used for authentication.

Example: jdoe

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the user within the study.",
            "format":"uuid"
        },
        "firstName":{
            "type":"string",
            "description":"User's first name.",
            "example":"John"
        },
        "lastName":{
            "type":"string",
            "description":"User's last name.",
            "example":"Doe"
        },
        "email":{
            "type":"string",
            "description":"User's email address.",
            "format":"email",
            "example":"studyuser@example.com"
        },
        "phone":{
            "type":"string",
            "description":"User's phone number.",
            "example":"+1-222-333-4444"
        },
        "userName":{
            "type":"string",
            "description":"Username used for authentication.",
            "example":"jdoe"
        },
        "lastAccess":{
            "type":"string",
            "description":"Timestamp (ISO8601/Z) when user last accessed the study.",
            "format":"date-time",
            "example":"2022-06-20T13:51:51Z"
        },
        "effectiveStart":{
            "type":"string",
            "description":"Effective start date for user's study access (ISO8601/Z).",
            "format":"date-time",
            "example":"2021-01-17T01:00:00Z"
        },
        "effectiveEnd":{
            "type":"string",
            "description":"Effective end date for user's study access (ISO8601/Z).",
            "format":"date-time",
            "example":"2025-01-17T01:00:00Z"
        },
        "roles":{
            "type":"array",
            "description":"Roles assigned to the user within the study.",
            "example":[
                "Rule Designer",
                "Site User"
            ],
            "items":{
                "type":"string",
                "description":"Roles assigned to the user within the study.",
                "example":"[\"Rule Designer\",\"Site User\"]"
            }
        },
        "sites":{
            "$ref":"#/components/schemas/DisplaySiteNamesListDto"
        },
        "depots":{
            "$ref":"#/components/schemas/DisplayDepotNamesListDto"
        }
    },
    "description":"Version 2: Extends DisplayStudyUserDto to include user email and phone information.",
    "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"
    }
}

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

allDepots: boolean

Flag indicating if the user has access to all depots within the study.

Example: false
associatedDepots: array associatedDepots

List of associated depot names for the user.

{
    "type":"object",
    "properties":{
        "allDepots":{
            "type":"boolean",
            "description":"Flag indicating if the user has access to all depots within the study.",
            "example":false
        },
        "associatedDepots":{
            "type":"array",
            "description":"List of associated depot names for the user.",
            "example":[
                "DepotA"
            ],
            "items":{
                "type":"string",
                "description":"List of associated depot names for the user.",
                "example":"[\"DepotA\"]"
            }
        }
    },
    "description":"Represents a set of depot access information for the user within a study, including all-depots flag and associated depot names.",
    "example":{
        "allDepots":false,
        "associatedDepots":[
            "DepotA"
        ]
    }
}

Example:

{
    "allDepots":false,
    "associatedDepots":[
        "DepotA"
    ]
}

Nested Schema : roles

Type: array

Roles assigned to the user within the study.

Show Source

Array of: string

Roles assigned to the user within the study.

Example: ["Rule Designer","Site User"]

{
    "type":"array",
    "description":"Roles assigned to the user within the study.",
    "example":[
        "Rule Designer",
        "Site User"
    ],
    "items":{
        "type":"string",
        "description":"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

allSites: boolean

Flag indicating if the user has access to all sites within the study.

Example: false
associatedSites: array associatedSites

List of associated site names for the user.

{
    "type":"object",
    "properties":{
        "allSites":{
            "type":"boolean",
            "description":"Flag indicating if the user has access to all sites within the study.",
            "example":false
        },
        "associatedSites":{
            "type":"array",
            "description":"List of associated site names for the user.",
            "example":[
                "SiteA",
                "SiteB"
            ],
            "items":{
                "type":"string",
                "description":"List of associated site names for the user.",
                "example":"[\"SiteA\",\"SiteB\"]"
            }
        }
    },
    "description":"Represents a set of site access information for the user within a study, including all-sites flag and associated site names.",
    "example":{
        "allSites":false,
        "associatedSites":[
            "SiteA",
            "SiteB"
        ]
    }
}

Example:

{
    "allSites":false,
    "associatedSites":[
        "SiteA",
        "SiteB"
    ]
}

Nested Schema : associatedDepots

Type: array

List of associated depot names for the user.

Show Source

Array of: string

List of associated depot names for the user.

Example: ["DepotA"]

{
    "type":"array",
    "description":"List of associated depot names for the user.",
    "example":[
        "DepotA"
    ],
    "items":{
        "type":"string",
        "description":"List of associated depot names for the user.",
        "example":"[\"DepotA\"]"
    }
}

Example:

[
    "DepotA"
]

Nested Schema : associatedSites

Type: array

List of associated site names for the user.

Show Source

Array of: string

List of associated site names for the user.

Example: ["SiteA","SiteB"]

{
    "type":"array",
    "description":"List of associated site names for the user.",
    "example":[
        "SiteA",
        "SiteB"
    ],
    "items":{
        "type":"string",
        "description":"List of associated site names for the user.",
        "example":"[\"SiteA\",\"SiteB\"]"
    }
}

Example:

[
    "SiteA",
    "SiteB"
]

400 Response

Bad request

Root Schema : AuthResponse

Type: object

Generic 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

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Indicates request success (\"success\") or failure (\"failure\").",
            "format":"none",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"Result data of the API response; actual type depends on the API",
            "example":null
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "description":"Version of the response schema.",
            "format":"int32",
            "example":1
        }
    },
    "description":"Generic API response wrapper containing result, error data, response version and status."
}

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

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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"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"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result data of the API response; actual type depends on the API

Example:

oracle.doceng.json.BetterJsonNull@3565a0f5