Jump to

• Request
• Response

[Deprecated]: Get list roles

get

/ec-auth-svc/rest/v1.0/authroles/{studyId}

Deprecated: Returns a list of user roles for a given study and study role type. Use /v3.0/authroles/{studyId} instead, which provides an expanded role schema with category, subcategory, unblinded, and version info for each role record.

Request

Path Parameters

• studyId(required): string(uuid)
  The unique ID of the study.

  Example:

  DA6FBE47F0E24A50BC5C462BB3525A41

Query Parameters

• studyRoleType(required): string
  Role type to filter roles by

  Example:

  Design

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 DisplayRoleDtoV2
  Represents a user role in v2 with additional details.

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

Nested Schema : DisplayRoleDtoV2

Type: object

Represents a user role in v2 with additional details.

Show Source

• id(required): string
  Unique identifier for the user role

  Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
• objectVersionNumber(required): integer (int32)
  Version number for optimistic locking

  Example: 1
• roleCategory(required): string
  Category of the role

  Example: Sponsor
• roleName(required): string
  The display name of the role

  Example: Monitor
• roleSubCategory: string
  Sub category of the role if available

  Example: Central
• roleType(required): string
  Type of the role (e.g., Runtime, Design)

  Example: Runtime
• unblinded: string
  Indicates if the role is unblinded (true/false)

  Example: true

{
    "required":[
        "id",
        "objectVersionNumber",
        "roleCategory",
        "roleName",
        "roleType"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for the user role",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "roleName":{
            "type":"string",
            "description":"The display name of the role",
            "example":"Monitor"
        },
        "roleType":{
            "type":"string",
            "description":"Type of the role (e.g., Runtime, Design)",
            "example":"Runtime"
        },
        "roleCategory":{
            "type":"string",
            "description":"Category of the role",
            "example":"Sponsor"
        },
        "roleSubCategory":{
            "type":"string",
            "description":"Sub category of the role if available",
            "example":"Central"
        },
        "unblinded":{
            "type":"string",
            "description":"Indicates if the role is unblinded (true/false)",
            "example":"true"
        },
        "objectVersionNumber":{
            "type":"integer",
            "description":"Version number for optimistic locking",
            "format":"int32",
            "example":1
        }
    },
    "description":"Represents a user role in v2 with additional details."
}

Examples

Select an example List of roles for study user

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