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

[Deprecated]: Update a user's mode and roles
put

/ec-auth-svc/rest/v1.0/authusers/{userid}/studies/{StudyID}

Deprecated: Use PUT /v2.0/authusers/{userid}/studies/{StudyID} for the updated API. The latest version supports richer assignment payloads, improved validation and more extensible structure. This endpoint only retrieves current assignments, while the new version supports updates with detailed structure and request validation. Deprecated: Use latest version instead. Updates the modes and roles for a user and a study.

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Request object for updating a user's study assignment, containing effective dates and role/mode/site/depot assignments.
Show Source
Example:
{
    "effectiveStart":"2020-06-17T10:15:30.000Z",
    "effectiveEnd":"2025-06-17T10:15:30.000Z",
    "modes":[
        {
            "modeName":"active",
            "roles":[
                {
                    "roleId":"F7A0E5390A1F43A9AF5346EB88AC921A",
                    "roleName":"Rule Designer"
                },
                {
                    "roleId":"EA0D45A19A6E45CDAAD5F2DB7BD4E104",
                    "roleName":"Site User"
                }
            ],
            "sites":{
                "allSites":false,
                "associatedSites":[
                    "946E7D36031941CCA39CD2B2CFF2899B",
                    "FE8925CFA8A74193A2E8D8326E7FEA88"
                ]
            },
            "depots":{
                "allDepots":false,
                "associatedDepots":[
                    "CEE624A4E7EB43059C6AEC24673A288B"
                ]
            }
        }
    ]
}
Nested Schema : modes
Type: object
Represents one mode assignment, including mode name, list of assigned roleIds, and assignment details for sites and depots.
Show Source
Example:
{
    "modeName":"active",
    "roles":[
        "F7A0E5390A1F43A9AF5346EB88AC921A",
        "EA0D45A19A6E45CDAAD5F2DB7BD4E104"
    ],
    "sites":{
        "allSites":false,
        "associatedSites":[
            "946E7D36031941CCA39CD2B2CFF2899B",
            "FE8925CFA8A74193A2E8D8326E7FEA88"
        ]
    },
    "depots":{
        "allDepots":false,
        "associatedDepots":[
            "CEE624A4E7EB43059C6AEC24673A288B"
        ]
    }
}
Nested Schema : DepotsListDto
Type: object
DTO containing the set of depot UUIDs assigned to the user in a study/mode context.
Show Source
Nested Schema : roles
Type: array
List of role UUIDs assigned to the user for this mode.
Show Source
Example:
[
    "F7A0E5390A1F43A9AF5346EB88AC921A",
    "EA0D45A19A6E45CDAAD5F2DB7BD4E104"
]
Nested Schema : SitesListDto
Type: object
Title: SitesListDto
DTO containing the set of site UUIDs assigned to the user in a study/mode context.
Show Source
Nested Schema : associatedDepots
Type: array
A list of UUIDs identifying depots assigned to the user.
Show Source
Example:
[
    "6E697AEB85A24A22B38C70495A0A5C48",
    "6E697AEB85A24A22B38C70495A0A5C49"
]
Nested Schema : associatedSites
Type: array
A list of UUIDs identifying sites assigned to the user.
Show Source
Example:
[
    "6E697AEB85A24A22B38C70495A0A5C48",
    "4E9523BF795D4FE4AB9BF1EF8A340FAB"
]
Examples

Back to Top

Response

Supported Media Types

200 Response

Success
Body ()
Root Schema : DisplayUserStudyModeRoleListDto
Type: object
Represents a user's assigned modes, roles, sites, and depots within a study, with study-wide effective dates.
Show Source
Example:
{
    "effectiveStart":"2020-06-17T10:15:30.000Z",
    "effectiveEnd":"2025-06-17T10:15:30.000Z",
    "modes":[
        {
            "modeName":"active",
            "roles":[
                {
                    "id":"F7A0E5390A1F43A9AF5346EB88AC921A",
                    "roleName":"Rule Designer"
                },
                {
                    "id":"EA0D45A19A6E45CDAAD5F2DB7BD4E104",
                    "roleName":"Site User"
                }
            ],
            "sites":{
                "allSites":false,
                "associatedSites":[
                    {
                        "id":"946E7D36031941CCA39CD2B2CFF2899B",
                        "siteName":"SiteA"
                    },
                    {
                        "id":"FE8925CFA8A74193A2E8D8326E7FEA88",
                        "siteName":"SiteB"
                    }
                ]
            },
            "depots":{
                "allDepots":false,
                "associatedDepots":[
                    {
                        "id":"CEE624A4E7EB43059C6AEC24673A288B",
                        "depotName":"DepotA"
                    }
                ]
            }
        }
    ]
}
Nested Schema : modes
Type: object
Represents a user's mode assignment in a study, including mode name, assigned roles, sites, and depots.
Show Source
Example:
{
    "modeName":"active",
    "roles":[
        {
            "id":"F7A0E5390A1F43A9AF5346EB88AC921A",
            "roleName":"Rule Designer"
        },
        {
            "id":"EA0D45A19A6E45CDAAD5F2DB7BD4E104",
            "roleName":"Site User"
        }
    ],
    "sites":{
        "allSites":false,
        "associatedSites":[
            {
                "id":"946E7D36031941CCA39CD2B2CFF2899B",
                "siteName":"SiteA"
            },
            {
                "id":"FE8925CFA8A74193A2E8D8326E7FEA88",
                "siteName":"SiteB"
            }
        ]
    },
    "depots":{
        "allDepots":false,
        "associatedDepots":[
            {
                "id":"CEE624A4E7EB43059C6AEC24673A288B",
                "depotName":"DepotA"
            }
        ]
    }
}
Nested Schema : DisplayDepotsListDto
Type: object
List of depots assigned to a user.
Show Source
Example:
{
    "allDepots":false,
    "associatedDepots":[
        {
            "id":"CEE624A4E7EB43059C6AEC24673A288B",
            "depotName":"DepotA"
        }
    ]
}
Nested Schema : roles
Type: object
Associates a user with a global role.
Show Source
Example:
{
    "id":"A519EF3C2B73455390CFF812AFF61519",
    "roleName":"STUDY_MANAGER"
}
Nested Schema : DisplaySitesListDto
Type: object
List of sites assigned to a user.
Show Source
Example:
{
    "allSites":false,
    "associatedSites":[
        {
            "id":"946E7D36031941CCA39CD2B2CFF2899B",
            "siteName":"SiteA"
        },
        {
            "id":"FE8925CFA8A74193A2E8D8326E7FEA88",
            "siteName":"SiteB"
        }
    ]
}
Nested Schema : associatedDepots
Type: object
Represents a clinical depot.
Show Source
Example:
{
    "id":"CEE624A4E7EB43059C6AEC24673A288B",
    "depotName":"DepotA"
}
Nested Schema : associatedSites
Type: object
Represents a clinical trial site.
Show Source
Example:
{
    "id":"946E7D36031941CCA39CD2B2CFF2899B",
    "siteName":"SiteA"
}
Examples

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