Get users for a depot
get
/ec-auth-svc/rest/v1.0/authstudies/{StudyID}/depots/{depotId}/users
Retrieves all authorized users for a depot for given study and depot Id.
Request
Path Parameters
-
StudyID(required): string(uuid)
Unique identifier for the study.Example:
ABE31741A0E945F6B827048B279F2F19 -
depotId(required): string(uuid)
Unique identifier for the depot within the study.Example:
TBE31741A0E945F6B827048B279F2F19
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
List of users for the specified depot and study.
Root Schema : DisplayUserListDto
Type:
objectPaginated result set of users for a global role.
Show Source
-
firstUserReturned: integer
(int32)
Index of the first user returned in this page.Example:
1 -
users: object
users
User details including name, username, and email address.
-
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
Nested Schema : users
Type:
objectUser details including name, username, and email address.
Show Source
-
emailAddress: string
User's email address.Example:
alice.brown@email.com -
firstName: string
User's first name.Example:
Alice -
id: string
Unique identifier for the user.Example:
1BC29B36F5D64B1B95F4BDBBCEA481BE -
lastName: string
User's last name.Example:
Brown -
userName: string
User's login name.Example:
alicebrown
Example:
[
{
"id":"1BC29B36F5D64B1B95F4BDBBCEA481BE",
"firstName":"Alice",
"lastName":"Brown",
"userName":"alicebrown",
"emailAddress":"alice.brown@email.com"
}
]Examples
400 Response
Bad request. StudyID or depotId is missing or not a validid.
Root Schema : AuthResponse
Type:
objectGeneric 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
Nested Schema : ErrorResponseData
Type:
objectStructure 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
Nested Schema : result
Type:
objectResult data of the API response; actual type depends on the API
Example:
oracle.doceng.json.BetterJsonNull@3565a0f5