Jump to

• Request
• Response

[Deprecated]: v3.0

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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

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

Select an example V3 structure for role-user assignments

400 Response

Bad request

Body ()

Root Schema : AuthResponse

Type: object

Generic API response wrapper containing result, error data, response version and status.

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• 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

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result data of the API response; actual type depends on the API

Example:

oracle.doceng.json.BetterJsonNull@65719c12

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Back to Top