REST API for Clinical One Platform

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

get

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

Deprecated: This endpoint is superseded by the v3 /globalroles/users endpoint (see v3 documentation). The latest (v3) version changes the response to use DisplayGlobalRoleUserListDtoV2 structure and introduces support for includeRemoved users and more flexible query parameters. Fetches a list of all global role-user assignments, filtered by optional search parameters.

Request

Query Parameters

SERVICE_TO_SERVICE_KEY (query): string
Internal service-to-service query param for trusted calls (true/false).
Example:
```
true
```
allusers: boolean
If true, include all users regardless of assignment.
Example:
```
false
```
firstResult: integer(int64)
First result to return (for paging).
Example:
```
0
```
rowsToReturn: integer(int64)
Maximum number of rows to return.
Example:
```
10
```
searchString: string
Text to search in username or role fields.
Example:
```
johndoe
```

Header Parameters

SERVICE_TO_SERVICE_KEY (header): string
Internal service-to-service header for trusted calls (true/false).
Example:
```
true
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : DisplayGlobalRoleUserListDto

Type: object

List of users for a global role, including pagination information.

Show Source

firstUserReturned: integer (int32)

Index of the first user returned (pagination).

Example: 1
globalusers: object globalusers

User associated with a global role, including profile and access information.
usersFound: integer (int32)

The total number of users found for the query.

Example: 2
usersReturned: integer (int32)

Number of users actually returned in this response.

Example: 2

{
    "type":"object",
    "properties":{
        "usersFound":{
            "type":"integer",
            "description":"The total number of users found for the query.",
            "format":"int32",
            "example":2
        },
        "firstUserReturned":{
            "type":"integer",
            "description":"Index of the first user returned (pagination).",
            "format":"int32",
            "example":1
        },
        "usersReturned":{
            "type":"integer",
            "description":"Number of users actually returned in this response.",
            "format":"int32",
            "example":2
        },
        "globalusers":{
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"Unique identifier of the user.",
                    "format":"uuid"
                },
                "firstName":{
                    "type":"string",
                    "description":"User's first name.",
                    "example":"John"
                },
                "lastName":{
                    "type":"string",
                    "description":"User's last name.",
                    "example":"Doe"
                },
                "userName":{
                    "type":"string",
                    "description":"User login name.",
                    "example":"johndoe"
                },
                "lastAccess":{
                    "type":"string",
                    "description":"Last access date/time in ISO 8601 format.",
                    "format":"date-time",
                    "example":"2023-10-01T12:00:00Z"
                },
                "globalroles":{
                    "type":"array",
                    "description":"List of global roles assigned to the user.",
                    "example":[
                        "ADMIN",
                        "REVIEWER"
                    ],
                    "items":{
                        "type":"string",
                        "description":"List of global roles assigned to the user.",
                        "example":"[\"ADMIN\",\"REVIEWER\"]"
                    }
                }
            },
            "description":"User associated with a global role, including profile and access information.",
            "example":{
                "id":"A1234567890BCDEF1234567890ABCDEF",
                "firstName":"John",
                "lastName":"Doe",
                "userName":"johndoe",
                "lastAccess":"2023-10-01T12:00:00.000Z",
                "globalroles":[
                    "ADMIN",
                    "REVIEWER"
                ]
            }
        }
    },
    "description":"List of users for a global role, including pagination information.",
    "example":{
        "usersFound":2,
        "firstUserReturned":1,
        "usersReturned":2,
        "globalusers":[
            {
                "id":"A1234567890BCDEF1234567890ABCDEF",
                "firstName":"John",
                "lastName":"Doe",
                "userName":"johndoe",
                "lastAccess":"2023-10-01T12:00:00.000Z",
                "globalroles":[
                    "ADMIN",
                    "REVIEWER"
                ]
            },
            {
                "id":"B1234567890BCDEF1234567890ABCDEF",
                "firstName":"Jane",
                "lastName":"Smith",
                "userName":"janesmith",
                "lastAccess":"2023-09-15T08:30:00.000Z",
                "globalroles":[
                    "USER"
                ]
            }
        ]
    }
}

Example:

{
    "usersFound":2,
    "firstUserReturned":1,
    "usersReturned":2,
    "globalusers":[
        {
            "id":"A1234567890BCDEF1234567890ABCDEF",
            "firstName":"John",
            "lastName":"Doe",
            "userName":"johndoe",
            "lastAccess":"2023-10-01T12:00:00.000Z",
            "globalroles":[
                "ADMIN",
                "REVIEWER"
            ]
        },
        {
            "id":"B1234567890BCDEF1234567890ABCDEF",
            "firstName":"Jane",
            "lastName":"Smith",
            "userName":"janesmith",
            "lastAccess":"2023-09-15T08:30:00.000Z",
            "globalroles":[
                "USER"
            ]
        }
    ]
}

Nested Schema : globalusers

Type: object

User associated with a global role, including profile and access information.

Show Source

firstName: string

User's first name.

Example: John
globalroles: array globalroles

List of global roles assigned to the user.
id: string (uuid)

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

Last access date/time in ISO 8601 format.

Example: 2023-10-01T12:00:00Z
lastName: string

User's last name.

Example: Doe
userName: string

User login name.

Example: johndoe

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the user.",
            "format":"uuid"
        },
        "firstName":{
            "type":"string",
            "description":"User's first name.",
            "example":"John"
        },
        "lastName":{
            "type":"string",
            "description":"User's last name.",
            "example":"Doe"
        },
        "userName":{
            "type":"string",
            "description":"User login name.",
            "example":"johndoe"
        },
        "lastAccess":{
            "type":"string",
            "description":"Last access date/time in ISO 8601 format.",
            "format":"date-time",
            "example":"2023-10-01T12:00:00Z"
        },
        "globalroles":{
            "type":"array",
            "description":"List of global roles assigned to the user.",
            "example":[
                "ADMIN",
                "REVIEWER"
            ],
            "items":{
                "type":"string",
                "description":"List of global roles assigned to the user.",
                "example":"[\"ADMIN\",\"REVIEWER\"]"
            }
        }
    },
    "description":"User associated with a global role, including profile and access information.",
    "example":{
        "id":"A1234567890BCDEF1234567890ABCDEF",
        "firstName":"John",
        "lastName":"Doe",
        "userName":"johndoe",
        "lastAccess":"2023-10-01T12:00:00.000Z",
        "globalroles":[
            "ADMIN",
            "REVIEWER"
        ]
    }
}

Example:

{
    "id":"A1234567890BCDEF1234567890ABCDEF",
    "firstName":"John",
    "lastName":"Doe",
    "userName":"johndoe",
    "lastAccess":"2023-10-01T12:00:00.000Z",
    "globalroles":[
        "ADMIN",
        "REVIEWER"
    ]
}

Nested Schema : globalroles

Type: array

List of global roles assigned to the user.

Show Source

Array of: string

List of global roles assigned to the user.

Example: ["ADMIN","REVIEWER"]

{
    "type":"array",
    "description":"List of global roles assigned to the user.",
    "example":[
        "ADMIN",
        "REVIEWER"
    ],
    "items":{
        "type":"string",
        "description":"List of global roles assigned to the user.",
        "example":"[\"ADMIN\",\"REVIEWER\"]"
    }
}

Example:

[
    "ADMIN",
    "REVIEWER"
]

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