REST API for Clinical One Platform

~~[Deprecated]: Get global roles users~~

get

/ec-auth-svc/rest/v3.0/globalroles/users

Deprecated: Retrieves users provisioned with global roles. Results can be filtered by user name and limited to a number.

Request

Query Parameters

allusers: boolean
All users
Example:
```
true
```
firstResult: integer(int32)
Offset from where the results should be retrieved
Example:
```
0
```
includeRemoved: string
Get removed details

Default Value: N
Example:
```
true
```
oracle.hsgbu.clinicalone.serviceToService: string
Service to service query key
Example:
```
role
```
rowsToReturn: integer(int32)
Limit for the number of results to be returned
Example:
```
50
```
searchString: string
Given name or family name of the user to filter the results.
Example:
```
Joh
```

Header Parameters

oracle.hsgbu.clinicalone.serviceToService: string
Service to service header key
Example:
```
name
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : DisplayGlobalRoleUserListDtoV2

Type: object

Show Source

firstUserReturned: integer (int32)
globalusers: array globalusers
usersFound: integer (int32)
usersReturned: integer (int32)

{
    "type":"object",
    "properties":{
        "usersFound":{
            "type":"integer",
            "format":"int32"
        },
        "firstUserReturned":{
            "type":"integer",
            "format":"int32"
        },
        "usersReturned":{
            "type":"integer",
            "format":"int32"
        },
        "globalusers":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DisplayGlobalRoleUserDtoV2"
            }
        }
    }
}

Nested Schema : globalusers

Type: array

Show Source

Array of: object DisplayGlobalRoleUserDtoV2

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

Nested Schema : DisplayGlobalRoleUserDtoV2

Type: object

Show Source

firstName: string
globalroles: array globalroles
id: string (uuid)
lastAccess: string (date-time)
lastName: string
userName: string
versionEnd: string (date-time)

End date for the object's version validity. ISO 8601 format.

Example: 2025-06-17T10:15:30Z
versionStart: string (date-time)

Start date for the object's version validity. ISO 8601 format.

Example: 2020-06-17T10:15:30Z

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "firstName":{
            "type":"string"
        },
        "lastName":{
            "type":"string"
        },
        "userName":{
            "type":"string"
        },
        "lastAccess":{
            "type":"string",
            "format":"date-time"
        },
        "globalroles":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DisplayUserRoleDtoV2"
            }
        },
        "versionStart":{
            "type":"string",
            "description":"Start date for the object's version validity. ISO 8601 format.",
            "format":"date-time",
            "example":"2020-06-17T10:15:30Z"
        },
        "versionEnd":{
            "type":"string",
            "description":"End date for the object's version validity. ISO 8601 format.",
            "format":"date-time",
            "example":"2025-06-17T10:15:30Z"
        }
    }
}

Nested Schema : globalroles

Type: array

Show Source

Array of: object DisplayUserRoleDtoV2

User role assignment within a study mode. Contains role reference, display label, and (if set) a mapped StudyRoleID. UUIDs are always uppercase.

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

Nested Schema : DisplayUserRoleDtoV2

Type: object

User role assignment within a study mode. Contains role reference, display label, and (if set) a mapped StudyRoleID. UUIDs are always uppercase.

Show Source

id: string

Unique role ID

Example: F0DEEFCB66A14C2AA0699165055A38C1
roleName: string

Display name for this application or system role.

Example: Data Manager
StudyRoleID: string

If present, the mapped StudyRoleID for this user/type.

Example: 23FF2AE2F25746B993190A489ED09727
versionEnd: string (date-time)

End date for the object's version validity. ISO 8601 format.

Example: 2025-06-17T10:15:30Z
versionStart: string (date-time)

Start date for the object's version validity. ISO 8601 format.

Example: 2020-06-17T10:15:30Z

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique role ID",
            "example":"F0DEEFCB66A14C2AA0699165055A38C1"
        },
        "roleName":{
            "type":"string",
            "description":"Display name for this application or system role.",
            "example":"Data Manager"
        },
        "versionStart":{
            "type":"string",
            "description":"Start date for the object's version validity. ISO 8601 format.",
            "format":"date-time",
            "example":"2020-06-17T10:15:30Z"
        },
        "versionEnd":{
            "type":"string",
            "description":"End date for the object's version validity. ISO 8601 format.",
            "format":"date-time",
            "example":"2025-06-17T10:15:30Z"
        },
        "StudyRoleID":{
            "type":"string",
            "description":"If present, the mapped StudyRoleID for this user/type.",
            "example":"23FF2AE2F25746B993190A489ED09727"
        }
    },
    "description":"User role assignment within a study mode. Contains role reference, display label, and (if set) a mapped StudyRoleID. UUIDs are always uppercase.",
    "example":[
        {
            "id":"F0DEEFCB66A14C2AA0699165055A38C1",
            "roleName":"Data Manager"
        }
    ]
}

Example:

[
    {
        "id":"F0DEEFCB66A14C2AA0699165055A38C1",
        "roleName":"Data Manager"
    }
]

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