Jump to

• Request
• Response

v1.0

get

/ec-auth-svc/rest/v1.0/authusers/study/{studyid}

Gets the list of users assigned to a specific study. Use studyId to select the study, and optionally exclude system users from the result. All user objects include attributes (ID, userName, email, roles, status, etc.).

Request

Path Parameters

• studyid(required): string(uuid)
  Unique identifier for the study to filter users.

  Example:

  DDF00A816BED40188DF769B206AD0EC6

Query Parameters

• excludeSystemUsers: boolean
  If true, users created by system processes are excluded.

  Default Value: false

  Example:

  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 DisplayUserDto2
  User details extending DisplayUserDto with versioning and auditing fields.

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

Nested Schema : DisplayUserDto2

Type: object

User details extending DisplayUserDto with versioning and auditing fields.

Show Source

• emailAddress: string
  User's email address.

  Example: [e-mail]
• firstName: string
  User's first name.

  Example: Alice
• id: string
  Unique identifier for the user.

  Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
• lastName: string
  User's last name.

  Example: Brown
• objectVersionNumber: number (double)
  Version number for the user object.

  Example: 2
• operationType: string
  Type of operation performed (e.g., CREATE, UPDATE, DELETE).

  Example: CREATE
• softwareVersionNumber: number (double)
  Version number for the software.

  Example: 1.5
• userName: string
  User's login name.

  Example: alicebrown
• versionEnd: string (date-time)
  Timestamp for when this version of the user record ended.

  Example: 2024-01-01T10:00:00Z
• versionStart: string (date-time)
  Timestamp for when this version of the user record started.

  Example: 2023-01-01T10:00:00Z

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for the user.",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "firstName":{
            "type":"string",
            "description":"User's first name.",
            "example":"Alice"
        },
        "lastName":{
            "type":"string",
            "description":"User's last name.",
            "example":"Brown"
        },
        "userName":{
            "type":"string",
            "description":"User's login name.",
            "example":"alicebrown"
        },
        "emailAddress":{
            "type":"string",
            "description":"User's email address.",
            "example":"[e-mail]"
        },
        "versionStart":{
            "type":"string",
            "description":"Timestamp for when this version of the user record started.",
            "format":"date-time",
            "example":"2023-01-01T10:00:00Z"
        },
        "versionEnd":{
            "type":"string",
            "description":"Timestamp for when this version of the user record ended.",
            "format":"date-time",
            "example":"2024-01-01T10:00:00Z"
        },
        "operationType":{
            "type":"string",
            "description":"Type of operation performed (e.g., CREATE, UPDATE, DELETE).",
            "example":"CREATE"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Version number for the user object.",
            "format":"double",
            "example":2
        },
        "softwareVersionNumber":{
            "type":"number",
            "description":"Version number for the software.",
            "format":"double",
            "example":1.5
        }
    },
    "description":"User details extending DisplayUserDto with versioning and auditing fields."
}

Examples

Select an example Sample audit users in study response

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