About API tasks and corresponding permissions

As a system administrator, you must select certain services for the client ID and secret. These services (or permissions) need to be assigned to the client ID on the oAuth Admin Console URL to gain proper access to the application's APIs.

When selecting permissions, evaluate the category of information that the developer intends to use and assign the corresponding microservices, as described in the table below.

For example, if your API developer is going to be designing a study using APIs, select the ec-designer-svc permission. You can add any amount of services that are applicable. If you do not know what specific APIs your developer will need, you can also select all of the permissions and go back later to refine them.

Note:

Clinical One Cloud Service APIs are protected with access rights in the specific study mode. If the mode query parameter is not specified on the API request, then the default mode used is Design. If the user is not assigned a role in the Design mode but is assigned the appropriate role to access the API in other modes, then make sure to add the query parameter mode=all to the API request.

API category	Permission in Oracle Health IAMS oAuth Admin Console
Code list	ec-codelist-svc
Coding	ec-coding-svc
Comments	ec-comment-svc
Data Action	ec-dataaction-svc
Data Capture	ec-dc-svc
Data Integration	ec-dataintegration-svc
Data Hub	ec-datahub-svc
Designer	ec-designer-svc ec-designer-edc-svc ec-designer-ors-svc ec-designer-study-svc
Digital Gateway	ib-ext-svc inthub-svc
File Upload	ec-fileupload-svc
Library	ec-library-svc
Notifications	ec-notifications-svc
Query	ec-query-svc
Randomization and Supplies	ec-ors-svc
Reporting	ec-reporting-svc
Rule Designer	ec-rule-designer-svc
Rule Execution	ec-rule-svc
Sites and Depots	ec-site-svc
Users, Permissions, and Roles	ec-auth-svc