Jump to

• Request
• Response

v1.0

get

/ec-auth-svc/rest/v1.0/authstudies/{studyId}/siteDepot/users

Retrieves all the users that belong to a study and have access to site and depot as logged in user

Request

Path Parameters

• studyId(required): string
  Study ID

  Example:

  ABE31741A0E945F6B827048B279F2F19

Query Parameters

• viewMode(required): string
  Mode of the study. Accepts active, test, or training

  Allowed Values: [ "design", "test", "training", "active", "all" ]

  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 RespUserBasicInfo

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

Nested Schema : RespUserBasicInfo

Type: object

Show Source

• firstName: string
  Given/first name of the user.

  Example: Divya
• id: string
  User unique identifier (32-character uppercase hexadecimal UUID).

  Example: B19DEFBA82754F709E142FB8A13D2120
• lastName: string
  Family/last name of the user.

  Example: Menon
• userName: string
  Unique system username for login or display.

  Example: divya.menon

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"User unique identifier (32-character uppercase hexadecimal UUID).",
            "example":"B19DEFBA82754F709E142FB8A13D2120"
        },
        "firstName":{
            "type":"string",
            "description":"Given/first name of the user.",
            "example":"Divya"
        },
        "lastName":{
            "type":"string",
            "description":"Family/last name of the user.",
            "example":"Menon"
        },
        "userName":{
            "type":"string",
            "description":"Unique system username for login or display.",
            "example":"divya.menon"
        }
    }
}

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