Jump to

• Request
• Response

Get a global user's roles

get

/ec-auth-svc/rest/v2.0/globalusers/{userid}/roles

Retrieves a global user's assigned roles.

Request

Path Parameters

• userid(required): string(uuid)
  A global user's ID whose roles have to be retrieved.

  Example:

  ABE31741A0E945F6B827048B279F2F19

Query Parameters

• includeRemoved: string
  Result should include removed objects.

  Default Value: N

  Example:

  N

• localize: boolean
  Default Value: false

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object RoleDtoParamsV3
  Represents an application role and its assignment attributes, including identifiers and display information.

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

Nested Schema : RoleDtoParamsV3

Type: object

Represents an application role and its assignment attributes, including identifiers and display information.

Show Source

• authorizedUserId: string (uuid)
• comment: string
• effectiveEnd: string (date-time)
• effectiveStart: string (date-time)
• id(required): string (uuid)
  Unique identifier of the application role.
• modeId: string (uuid)
• objectVersionNumber: number
• operationType: string
• reason: string
• rightId: string (uuid)
• roleCategory(required): string
  Business category of the role.

  Example: Study
• roleName(required): string
  Human-readable role name.

  Example: VIEWER
• roleSeq: number (int32)
  Role sequence/order in assignment.

  Example: 1
• roleSubCategory: string
• roleType(required): string
  Type of the role (e.g., Application, Study, Global).

  Example: Application
• softwareVersionNumber: number
• studyId: string (uuid)
• studyRoleId: string (uuid)
• unblinded: string
  Indicates if the role is unblinded (Y/N).

  Example: Y
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "required":[
        "id",
        "roleCategory",
        "roleName",
        "roleType"
    ],
    "type":"object",
    "properties":{
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "authorizedUserId":{
            "type":"string",
            "format":"uuid"
        },
        "modeId":{
            "type":"string",
            "format":"uuid"
        },
        "studyRoleId":{
            "type":"string",
            "format":"uuid"
        },
        "id":{
            "type":"string",
            "description":"Unique identifier of the application role.",
            "format":"uuid"
        },
        "rightId":{
            "type":"string",
            "format":"uuid"
        },
        "roleName":{
            "type":"string",
            "description":"Human-readable role name.",
            "example":"VIEWER"
        },
        "roleType":{
            "type":"string",
            "description":"Type of the role (e.g., Application, Study, Global).",
            "example":"Application"
        },
        "roleCategory":{
            "type":"string",
            "description":"Business category of the role.",
            "example":"Study"
        },
        "roleSubCategory":{
            "type":"string"
        },
        "unblinded":{
            "type":"string",
            "description":"Indicates if the role is unblinded (Y/N).",
            "example":"Y"
        },
        "roleSeq":{
            "type":"number",
            "description":"Role sequence/order in assignment.",
            "format":"int32",
            "example":1
        },
        "effectiveStart":{
            "type":"string",
            "format":"date-time"
        },
        "effectiveEnd":{
            "type":"string",
            "format":"date-time"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "reason":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        }
    },
    "description":"Represents an application role and its assignment attributes, including identifiers and display information.",
    "example":{
        "id":"37EFDC494C944E58ADAC8DA952A2C60C",
        "roleName":"Site User",
        "roleType":"Application",
        "roleCategory":"Study",
        "roleSeq":1,
        "unblinded":"Y"
    }
}

Example:

{
    "id":"37EFDC494C944E58ADAC8DA952A2C60C",
    "roleName":"Site User",
    "roleType":"Application",
    "roleCategory":"Study",
    "roleSeq":1,
    "unblinded":"Y"
}

Examples

Select an example A list of user's assigned global roles (v3 schema)

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
• 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

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

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

Example:

oracle.doceng.json.BetterJsonNull@1466a41f

Nested Schema : details

Type: object

Back to Top