Help Center/ API Gateway/ User Guide/ Credentials/ Creating a Credential and Binding It to APIs

Updated on 2024-08-16 GMT+08:00

View PDF

Creating a Credential and Binding It to APIs

For APIs that use app authentication, create credentials to generate credential IDs and key/secret pairs. When calling such an API, bind a credential to the API, use the key/secret pair to replace that in the SDK so that APIG can authenticate your identity. For details about app authentication, see the Developer Guide.

APIs that use IAM, custom authentication or require no authentication do not need credentials.
You can create a maximum of 50 credentials for each gateway.

Creating a Credential

Go to the APIG console.
Select a dedicated gateway at the top of the navigation pane.

In the navigation pane, choose API Management > Credentials.

Click Create Credential and set credential information.

**Table 1** Credential information
Parameter	Description
Name	Credential name.
Description	Description about the credential.

You can customize AppKeys (keys) and AppSecrets (secrets). An AppKey is an automatically generated identifier, which is globally unique. You are not advised to customize one unless it is necessary.

Click OK.
- After the credential is created, its name and ID are displayed on the Credentials page.
- Click the credential name and view the key and secret.

Binding a Credential to APIs

On the Credentials page, click the name of the target credential.
In the APIs area, click Bind to APIs.
Select an environment, API group, and APIs.
Click OK.

To unbind an API, click Unbind in the row that contains the API.

A credential can be bound to multiple APIs that use app authentication, and each such API can be bound with multiple credentials.