REST API for Clinical One Platform

Create and assign bulk users

post

/ec-auth-svc/rest/v1.0/authusers/studies/{StudyID}/bulk

Create multiple users in bulk for a study. Provide StudyID in path, and a list of user objects in the body. The request allows for both federated and training users.

Request

Path Parameters

StudyID(required): string(uuid)
Unique identifier for the study where the users will be created.
Example:
```
85EFD8B9FF11437F8D0DA3F314A9D123
```

Query Parameters

runAsync: boolean
If true, run asynchronously. Defaults to false.

Default Value: false
Example:
```
false
```

Supported Media Types

application/json

Root Schema : schema

Type: object

Payload for uploading a batch of users, including user details and bulk flags.

Show Source

comment: string

Optional comment for the bulk user creation.

Example: Bulk upload of new investigators
isFederatedUser: boolean

True if the users are federated users.

Example: true
isTrainingModeUpload: boolean

True if the users are part of a training mode upload.

Example: false
users: object users

Details required for a single user in a bulk upload.

{
    "type":"object",
    "properties":{
        "isFederatedUser":{
            "type":"boolean",
            "description":"True if the users are federated users.",
            "example":true
        },
        "isTrainingModeUpload":{
            "type":"boolean",
            "description":"True if the users are part of a training mode upload.",
            "example":false
        },
        "comment":{
            "type":"string",
            "description":"Optional comment for the bulk user creation.",
            "example":"Bulk upload of new investigators"
        },
        "users":{
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"Unique identifier for the user.",
                    "format":"uuid"
                },
                "idcsId":{
                    "type":"string",
                    "description":"IDCS identifier if federated.",
                    "format":"uuid"
                },
                "firstName":{
                    "type":"string",
                    "description":"User's first name.",
                    "example":"John"
                },
                "lastName":{
                    "type":"string",
                    "description":"User's last name.",
                    "example":"Smith"
                },
                "userName":{
                    "type":"string",
                    "description":"User's login name.",
                    "example":"jsmith"
                },
                "emailId":{
                    "type":"string",
                    "description":"User's email address.",
                    "example":"john.smith@email.com"
                },
                "role":{
                    "type":"string",
                    "description":"Assigned user role.",
                    "example":"SiteAdmin"
                },
                "sites":{
                    "type":"string",
                    "description":"Comma separated list of associated site names.",
                    "example":"SiteA,SiteB"
                },
                "depots":{
                    "type":"string",
                    "description":"Comma separated list of associated depots.",
                    "example":"DepotA"
                },
                "startDate":{
                    "type":"string",
                    "description":"Start date of user assignment in ISO format.",
                    "format":"date"
                },
                "endDate":{
                    "type":"string",
                    "description":"End date of user assignment in ISO format.",
                    "format":"date"
                }
            },
            "description":"Details required for a single user in a bulk upload.",
            "example":{
                "id":"F6B4E947CA41478DBE30CEF0A823BC43",
                "idcsId":"D196BD697CB34E169A7D8E465AB8B2F5",
                "firstName":"John",
                "lastName":"Smith",
                "userName":"jsmith",
                "emailId":"john.smith@email.com",
                "role":"SiteAdmin",
                "sites":"SiteA,SiteB",
                "depots":"DepotA",
                "startDate":"2025-12-31T00:00:00.000Z",
                "endDate":"3099-12-31T00:00:00.000Z"
            }
        }
    },
    "description":"Payload for uploading a batch of users, including user details and bulk flags."
}

Nested Schema : users

Type: object

Details required for a single user in a bulk upload.

Show Source

depots: string

Comma separated list of associated depots.

Example: DepotA
emailId: string

User's email address.

Example: john.smith@email.com
endDate: string (date)

End date of user assignment in ISO format.
firstName: string

User's first name.

Example: John
id: string (uuid)

Unique identifier for the user.
idcsId: string (uuid)

IDCS identifier if federated.
lastName: string

User's last name.

Example: Smith
role: string

Assigned user role.

Example: SiteAdmin
sites: string

Comma separated list of associated site names.

Example: SiteA,SiteB
startDate: string (date)

Start date of user assignment in ISO format.
userName: string

User's login name.

Example: jsmith

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for the user.",
            "format":"uuid"
        },
        "idcsId":{
            "type":"string",
            "description":"IDCS identifier if federated.",
            "format":"uuid"
        },
        "firstName":{
            "type":"string",
            "description":"User's first name.",
            "example":"John"
        },
        "lastName":{
            "type":"string",
            "description":"User's last name.",
            "example":"Smith"
        },
        "userName":{
            "type":"string",
            "description":"User's login name.",
            "example":"jsmith"
        },
        "emailId":{
            "type":"string",
            "description":"User's email address.",
            "example":"john.smith@email.com"
        },
        "role":{
            "type":"string",
            "description":"Assigned user role.",
            "example":"SiteAdmin"
        },
        "sites":{
            "type":"string",
            "description":"Comma separated list of associated site names.",
            "example":"SiteA,SiteB"
        },
        "depots":{
            "type":"string",
            "description":"Comma separated list of associated depots.",
            "example":"DepotA"
        },
        "startDate":{
            "type":"string",
            "description":"Start date of user assignment in ISO format.",
            "format":"date"
        },
        "endDate":{
            "type":"string",
            "description":"End date of user assignment in ISO format.",
            "format":"date"
        }
    },
    "description":"Details required for a single user in a bulk upload.",
    "example":{
        "id":"F6B4E947CA41478DBE30CEF0A823BC43",
        "idcsId":"D196BD697CB34E169A7D8E465AB8B2F5",
        "firstName":"John",
        "lastName":"Smith",
        "userName":"jsmith",
        "emailId":"john.smith@email.com",
        "role":"SiteAdmin",
        "sites":"SiteA,SiteB",
        "depots":"DepotA",
        "startDate":"2025-12-31T00:00:00.000Z",
        "endDate":"3099-12-31T00:00:00.000Z"
    }
}

Example:

{
    "id":"F6B4E947CA41478DBE30CEF0A823BC43",
    "idcsId":"D196BD697CB34E169A7D8E465AB8B2F5",
    "firstName":"John",
    "lastName":"Smith",
    "userName":"jsmith",
    "emailId":"john.smith@email.com",
    "role":"SiteAdmin",
    "sites":"SiteA,SiteB",
    "depots":"DepotA",
    "startDate":"2025-12-31T00:00:00.000Z",
    "endDate":"3099-12-31T00:00:00.000Z"
}

Examples

Response

Supported Media Types

application/json

200 Response

Success

400 Response

Bad request

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

500 Response

Error

Root 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."
}