REST API for Clinical One Platform

Get user roles in a study

get

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

Retrieve the list of roles assigned to users for the specified study. The 'StudyID' path parameter (UUID, HEX, e.g., "31BAA8B711634A7997A9E6C71B0819CA") identifies the target study. The response is an array of DisplayStudyUserRolesDto, where each object describes a role category and contains a list of role objects assigned for that category.

Request

Path Parameters

StudyID(required): string(uuid)
Unique study identifier.
Example:
```
31BAA8B711634A7997A9E6C71B0819CA
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

List of study user roles returned successfully.

Root Schema : schema

Type: array

Show Source

Array of: object DisplayStudyUserRolesDto

Describes user roles within a study, indicating the type/category and a list of role objects assigned (typically study role details).

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DisplayStudyUserRolesDto"
    }
}

Nested Schema : DisplayStudyUserRolesDto

Type: object

Describes user roles within a study, indicating the type/category and a list of role objects assigned (typically study role details).

Show Source

roles: array roles

List of role objects (actual schema depends on the use context, typically a DTO representing role details).
roleType: string

Type or category of the role for the user within a study (such as INVESTIGATOR, VIEWER, etc).

Example: design

{
    "type":"object",
    "properties":{
        "roleType":{
            "type":"string",
            "description":"Type or category of the role for the user within a study (such as INVESTIGATOR, VIEWER, etc).",
            "example":"design"
        },
        "roles":{
            "type":"array",
            "description":"List of role objects (actual schema depends on the use context, typically a DTO representing role details).",
            "example":[
                {
                    "roleId":"D0F183DC273340CEA7AFDCB93A5B3D4B",
                    "roleName":"Assign Site to a Study"
                },
                {
                    "roleId":"9ED1AE19B0B04188B8A70A8D8374F315",
                    "roleName":"View Library Objects"
                }
            ],
            "items":{
                "type":"object",
                "description":"List of role objects (actual schema depends on the use context, typically a DTO representing role details).",
                "example":[
                    {
                        "roleId":"D0F183DC273340CEA7AFDCB93A5B3D4B",
                        "roleName":"Assign Site to a Study"
                    },
                    {
                        "roleId":"9ED1AE19B0B04188B8A70A8D8374F315",
                        "roleName":"View Library Objects"
                    }
                ]
            }
        }
    },
    "description":"Describes user roles within a study, indicating the type/category and a list of role objects assigned (typically study role details).",
    "example":"{\n  \"roleType\": \"design\",\n  \"roles\": [\n    {\n      \"roleId\": \"D0F183DC273340CEA7AFDCB93A5B3D4B\",\n      \"roleName\": \"Assign Site to a Study\",\n    },\n    {\n      \"roleId\": \"9ED1AE19B0B04188B8A70A8D8374F315\",\n      \"roleName\": \"View Library Objects\",\n    }\n  ]\n}"
}

Example:

{
  "roleType": "design",
  "roles": [
    {
      "roleId": "D0F183DC273340CEA7AFDCB93A5B3D4B",
      "roleName": "Assign Site to a Study",
    },
    {
      "roleId": "9ED1AE19B0B04188B8A70A8D8374F315",
      "roleName": "View Library Objects",
    }
  ]
}

Nested Schema : roles

Type: array

List of role objects (actual schema depends on the use context, typically a DTO representing role details).

Show Source

Array of: object items

List of role objects (actual schema depends on the use context, typically a DTO representing role details).

{
    "type":"array",
    "description":"List of role objects (actual schema depends on the use context, typically a DTO representing role details).",
    "example":[
        {
            "roleId":"D0F183DC273340CEA7AFDCB93A5B3D4B",
            "roleName":"Assign Site to a Study"
        },
        {
            "roleId":"9ED1AE19B0B04188B8A70A8D8374F315",
            "roleName":"View Library Objects"
        }
    ],
    "items":{
        "type":"object",
        "description":"List of role objects (actual schema depends on the use context, typically a DTO representing role details).",
        "example":[
            {
                "roleId":"D0F183DC273340CEA7AFDCB93A5B3D4B",
                "roleName":"Assign Site to a Study"
            },
            {
                "roleId":"9ED1AE19B0B04188B8A70A8D8374F315",
                "roleName":"View Library Objects"
            }
        ]
    }
}

Example:

[
    {
        "roleId":"D0F183DC273340CEA7AFDCB93A5B3D4B",
        "roleName":"Assign Site to a Study"
    },
    {
        "roleId":"9ED1AE19B0B04188B8A70A8D8374F315",
        "roleName":"View Library Objects"
    }
]

Nested Schema : items

Type: object

List of role objects (actual schema depends on the use context, typically a DTO representing role details).

Example:

[
    {
        "roleId":"D0F183DC273340CEA7AFDCB93A5B3D4B",
        "roleName":"Assign Site to a Study"
    },
    {
        "roleId":"9ED1AE19B0B04188B8A70A8D8374F315",
        "roleName":"View Library Objects"
    }
]

Examples

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