Jump to

• Request
• Response

Get users for a site

get

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

Retrieves all authorized users for a site and given study.

Request

Path Parameters

• siteId(required): string(uuid)
  Unique identifier for the site within the study.

  Example:

  A8C437F7F76D4DBE999FCB110A1DC489

• studyId(required): string(uuid)
  Unique identifier for the study

  Example:

  ABE31741A0E945F6B827048B279F2F19

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

User list for the given site in the study.

Body ()

Root Schema : DisplayUserListDto

Type: object

Paginated result set of users for a global role.

Show Source

• firstUserReturned: integer (int32)
  Index of the first user returned in this page.

  Example: 1
• users: object users
  User details including name, username, and email address.
• usersFound: integer (int32)
  The total number of users found matching the query.

  Example: 2
• usersReturned: integer (int32)
  How many users are present in this response.

  Example: 2

{
    "type":"object",
    "properties":{
        "usersFound":{
            "type":"integer",
            "description":"The total number of users found matching the query.",
            "format":"int32",
            "example":2
        },
        "firstUserReturned":{
            "type":"integer",
            "description":"Index of the first user returned in this page.",
            "format":"int32",
            "example":1
        },
        "usersReturned":{
            "type":"integer",
            "description":"How many users are present in this response.",
            "format":"int32",
            "example":2
        },
        "users":{
            "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]"
                }
            },
            "description":"User details including name, username, and email address.",
            "example":[
                {
                    "id":"1BC29B36F5D64B1B95F4BDBBCEA481BE",
                    "firstName":"Alice",
                    "lastName":"Brown",
                    "userName":"alicebrown",
                    "emailAddress":"[e-mail]"
                }
            ]
        }
    },
    "description":"Paginated result set of users for a global role."
}

Nested Schema : users

Type: object

User details including name, username, and email address.

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
• userName: string
  User's login name.

  Example: alicebrown

{
    "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]"
        }
    },
    "description":"User details including name, username, and email address.",
    "example":[
        {
            "id":"1BC29B36F5D64B1B95F4BDBBCEA481BE",
            "firstName":"Alice",
            "lastName":"Brown",
            "userName":"alicebrown",
            "emailAddress":"[e-mail]"
        }
    ]
}

Example:

[
    {
        "id":"1BC29B36F5D64B1B95F4BDBBCEA481BE",
        "firstName":"Alice",
        "lastName":"Brown",
        "userName":"alicebrown",
        "emailAddress":"[e-mail]"
    }
]

Examples

Select an example Users list for a site, including all user and contact fields.

400 Response

Bad request. studyId or siteId is missing or not a valid id.

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