Defining API key security schemes
An API key security scheme is used to specify the credentials that an application must provide to identify itself when calling the API operations.
About this task
You can complete this task either by using the API Designer UI application, or by using the browser-based API Manager UI.
You can require that, when calling an API operation, an application must provide either a client ID, or a client ID and client secret; you create an API key security scheme to specify a credentials requirement. If you require that an application must provide both a client ID and client secret, you must create two API key security schemes, one for each type of credentials.
To make use of an API key security scheme, you must reference it from elsewhere in your API definition. For more information, see Enforcing security requirements on an API and Enforcing security requirements on an operation.
At any time, you can switch directly to the underlying OpenAPI YAML
source by clicking the Source icon .
To return to the design form, click the Form icon
.