REST API for Clinical One Platform

Get all unassigned users for a study

get

/ec-auth-svc/rest/v2.0/authstudies/{StudyID}/users/unassigned

Retrieve users who are not assigned to a study.

Request

Path Parameters

StudyID(required): string(uuid)
Unique identifier for the study.
Example:
```
BCF73296C9404DFD9ABEC81DEB4A9671
```

Query Parameters

firstResult: integer(int32)
Index of first user record to return for pagination.
Example:
```
0
```
isSvcToSvc2: string
Service-to-service authentication flag in query param. Pass 'true' to include service accounts.
Example:
```
true
```
rowsToReturn: integer(int32)
How many records to return per page.
Example:
```
10
```
searchString: string
Filter for user name or login.
Example:
```
Pat
```

Header Parameters

isSvcToSvc1: string
Service-to-service authentication header for privileged calls. Pass 'true' to include service accounts.
Example:
```
true
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Unassigned users for the specified study returned successfully.

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

Example:

[
    {
        "id":"1BC29B36F5D64B1B95F4BDBBCEA481BE",
        "firstName":"Alice",
        "lastName":"Brown",
        "userName":"alicebrown",
        "emailAddress":"alice.brown@email.com"
    }
]

Examples

400 Response

Bad request. Returned when StudyID is missing.

Root Schema : AuthResponse

Type: object

Generic API response wrapper containing result, error data, response version and status.

Show Source

errorData: object ErrorResponseData

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

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

Example:

oracle.doceng.json.BetterJsonNull@3565a0f5