Authorizing an API Which Uses IAM Authentication to Apps

Notes and Constraints

• APIs which use IAM authentication authorized to apps of the IAM type can be called only using the token of the current account or those of its users, rather than any other account or user If needed, you can use a whitelist to authorize the APIs to other accounts. For details, see Authorizing an API Which Uses IAM Authentication Through a Whitelist.
• APIs using the IAM authentication can be authorized only to apps of the IAM type.
• If you authorize apps to call an API without authentication, the system ignores this operation.
• Only one app of the IAM type can be created for each DataArts Studio instance. The app name is fixed at the a Huawei account and cannot be changed.
• In DataArts DataService Exclusive, APIs which use IAM authentication must be authorized through apps or whitelists so that they can be called.

Creating an App of the IAM Type

1. On the DataArts Studio console, locate a workspace and click DataArts DataService.

2. In the left navigation pane, choose an edition, for example, Exclusive Edition. The Overview page is displayed.
3. Choose API Calling > Apps. On the page displayed, click Create. The Create App dialog box is displayed. Set the parameters listed in Table 1.

   Table 1 App information

   Parameter	Description
   App Name	App name, which is fixed at the a Huawei account and cannot be changed.
   Type	Select IAM. APIs using the IAM authentication mode can be authorized only to apps of the IAM type. IAM: APIs using IAM authentication can be authorized to apps of this type. The name of an app of the IAM type is fixed at the a Huawei account. Only one such app can be created for each DataArts Studio instance and is visible to all workspaces in the instance. APP: APIs using app authentication can be authorized to apps of this type. You can authorize APIs using different app authentication modes to different apps to improve data security.
   Description	A description of the app to create

4. Click OK.

   After the app is created, its name and ID are displayed in the application list.

Authorizing an API Which Uses IAM Authentication to the Current Account

An API that uses IAM authentication can be called only after it is authorized. Authorization can be performed by an API developer or an API caller. This section uses the former as an example.

1. On the DataArts Studio console, locate a workspace and click DataArts DataService.

2. In the left navigation pane, choose an edition, for example, Exclusive Edition. The Overview page is displayed.
3. Choose API Development > APIs.
4. Locate the row that contains an API which uses IAM authentication, click More in the Operation column, and select View Authorization. On the Complete Information tab page, click Assign Authorization.
5. In the Authorize Apps dialog box, set Expires and Cluster, select IAM apps, and click OK.
   Figure 1 Authorize Apps
   

6. After the authorization is complete, view the bound APIs on the app details page.
   

   • In the API list, if you no longer access an API through the app, click Unbind in the Operation column.
   • To test an API to which the app is bound, choose More > Debug in the Operation column
   • To extend the authorization period for the bound API, click Renew.

Related Operations

Authorizing an API to multiple apps: On the APIs page, select APIs, click Batch Operation above the list, and select Authorize.

You cannot authorize APIs of different authentication modes to apps simultaneously.

Figure 2 Batch Operation