REST API for Clinical One Cloud Service

v1.0

get

/ec-auth-svc/rest/v1.0/userinfo/bulk

Deprecated: Use '/v2.0/userinfo/bulk' instead. Returns a list of users having the specified rights for a study. Suggest using v2 for expanded user info (attributes, strict UUIDs, additional filters).

Request

Query Parameters

rightnames(required): string
Comma separated rights to match.
Example:
```
[
    "DesignerRandListGet",
    "SchedulerDelete"
]
```
studyId: string(uuid)
Study UUID for which to filter users.
Example:
```
EC026DEDC88723C3E053EB944C645888
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object UserInfoDtoV3

User information (v3): All user info including attributes and global rights.

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

Nested Schema : UserInfoDtoV3

Type: object

User information (v3): All user info including attributes and global rights.

Show Source

emailAddress: string (email)

User's email address

Example: eve.johnson@example.com
firstName: string

User's first name

Example: Eve
globalRights: array globalRights

Unique Items Required: true

Set of user's global rights
lastName: string

User's last name

Example: Johnson
userAttributes: object userAttributes

Key-value pair for user attribute
userId: string (uuid)

User identifier.

{
    "type":"object",
    "properties":{
        "firstName":{
            "type":"string",
            "description":"User's first name",
            "example":"Eve"
        },
        "lastName":{
            "type":"string",
            "description":"User's last name",
            "example":"Johnson"
        },
        "emailAddress":{
            "type":"string",
            "description":"User's email address",
            "format":"email",
            "example":"eve.johnson@example.com"
        },
        "userId":{
            "type":"string",
            "description":"User identifier.",
            "format":"uuid"
        },
        "globalRights":{
            "uniqueItems":true,
            "type":"array",
            "description":"Set of user's global rights",
            "example":[
                "Lab Get",
                "Rule Designer"
            ],
            "items":{
                "type":"string",
                "description":"Set of user's global rights",
                "example":"[\"Lab Get\",\"Rule Designer\"]"
            }
        },
        "userAttributes":{
            "type":"object",
            "properties":{
                "key":{
                    "type":"string",
                    "description":"The attribute key name",
                    "example":"Locale"
                },
                "value":{
                    "type":"string",
                    "description":"The value of the attribute",
                    "example":"en-US"
                }
            },
            "description":"Key-value pair for user attribute",
            "example":{
                "key":"Locale",
                "value":"en-US"
            }
        }
    },
    "description":"User information (v3): All user info including attributes and global rights.",
    "example":{
        "firstName":"Eve",
        "lastName":"Johnson",
        "emailAddress":"eve.johnson@example.com",
        "userId":"EC026DEDC88723C3E053EB944C645812",
        "globalRights":[
            "UpdateRecipe",
            "OrsSiteShipmentPost"
        ],
        "userAttributes":[
            {
                "key":"Locale",
                "value":"en-US"
            },
            {
                "key":"TimeZone",
                "value":"Europe/Paris"
            }
        ]
    }
}

Example:

{
    "firstName":"Eve",
    "lastName":"Johnson",
    "emailAddress":"eve.johnson@example.com",
    "userId":"EC026DEDC88723C3E053EB944C645812",
    "globalRights":[
        "UpdateRecipe",
        "OrsSiteShipmentPost"
    ],
    "userAttributes":[
        {
            "key":"Locale",
            "value":"en-US"
        },
        {
            "key":"TimeZone",
            "value":"Europe/Paris"
        }
    ]
}

Nested Schema : globalRights

Type: array

Unique Items Required: true

Set of user's global rights

Show Source

Array of: string

Set of user's global rights

Example: ["Lab Get","Rule Designer"]

{
    "uniqueItems":true,
    "type":"array",
    "description":"Set of user's global rights",
    "example":[
        "Lab Get",
        "Rule Designer"
    ],
    "items":{
        "type":"string",
        "description":"Set of user's global rights",
        "example":"[\"Lab Get\",\"Rule Designer\"]"
    }
}

Example:

[
    "Lab Get",
    "Rule Designer"
]

Nested Schema : userAttributes

Type: object

Key-value pair for user attribute

Show Source

key: string

The attribute key name

Example: Locale
value: string

The value of the attribute

Example: en-US

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string",
            "description":"The attribute key name",
            "example":"Locale"
        },
        "value":{
            "type":"string",
            "description":"The value of the attribute",
            "example":"en-US"
        }
    },
    "description":"Key-value pair for user attribute",
    "example":{
        "key":"Locale",
        "value":"en-US"
    }
}

Example:

{
    "key":"Locale",
    "value":"en-US"
}

Examples

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

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.