Parameter | Description |
Condition | Specifies the condition operator for the identification and authentication types. Select any of the following condition operators: ![]() ![]() Note: Even though this policy provides the option of choosing an AND or OR operation between the different identification and authentication types, the operation across the different policies in the IAM stage is always AND. For example, configuring the Identify and Authorize Application policy with API Key and the Inbound Authentication - Transport policy with HTTP Basic Authentication using an OR operation is not supported. |
Allow anonymous | Specifies whether to allow all users to access the API without restriction. When you add a security policy and configure Allow anonymous, all requests are allowed to pass through to the native API, but the successfully identified requests are grouped under the respective identified application, and all unidentified requests are grouped under a common application named unknown. While you allow all requests to pass through you can perform all application-specific actions, such as, viewing the runtime events for a particular application, monitor the service level agreement for a few applications and send an alert email based on some criteria like request count or availability, and throttle the requests from a particular application and not allow the request from that application if the number of requests reach the configured hard limit within configured period of time. |
Identification Type. Specifies the identification type. You can select any of the following. | |
API Key | Specifies using the API key to identify and validate the client's API key to verify the client's identity in the registered list of applications for the specified API. Select one of the Application Lookup condition: ![]() ![]() ![]() When this option is selected, you can use the API key as: ![]() x-Gateway-APIKey:a4b5d569-2450-11e3-b3fc-b5a70ab4288a ![]() http://pie-3HKYMH2:5555/gateway/PetstoreAPI/1.0.3/store/ inventory?APIKey=faab7ac6-97a4-4228-908d-f1930faba470 |
Hostname Address | Specifies using host name address to identify the client, extract the client's hostname from the HTTP request header and verify the client's identity in the specified list of applications in API Gateway. Select one of the Application Lookup condition: ![]() ![]() Note: If the client request has X-Forwarded-For header, then API Gateway resolves the hostname from the IP address present in the X-Forwarded-For header. Else, API Gateway resolves the hostname from the client's IP address. ![]() |
HTTP Basic Authentication | Specifies using Authorization Header in the request to identify and authorize the client application against the list of applications with the identifier username in API Gateway. Select one of the Application Lookup condition ![]() ![]() ![]() Note: You can use the username for further processing using the request transformation policy. ![]() Possible values: ![]() false. Requests without authorization headers are not logged as a policy violation event. |
IP Address Range | Specifies using the IP address range to identify the client, extract the client's IP address from the HTTP request header, and verify the client's identity against the specified list of applications in API Gateway. Select one of the Application Lookup condition: ![]() ![]() Note: If the client request has X-Forwarded-For header, then API Gateway uses the IP address present in the X-Forwarded-For header. Else, API Gateway uses the client's IP address for identification. |
JWT | Specifies using the JSON Web Token (JWT) to identify the client, extract the claims from the JWT and validate the client's claims, and verify the client's identity against the specified list of applications in API Gateway. Select one of the Application Lookup condition: ![]() ![]() Note: You can use the claims in the JWT for further processing using request transformation policy. |
Kerberos Token | Specifies using the Kerberos token to identify the client, extract the client's credentials from the Kerberos token, and verify the client's identity against the specified list of applications in API Gateway. Select one of the Application Lookup condition: ![]() ![]() Note: You can use the username for further processing using the request transformation policy. |
OAuth2 Token | Specifies using the OAuth2 token to identify the client, extract the client's credentials from the HTTP request header, and verify the client's identity against the specified list of applications in API Gateway. Note: You can use the client id and other parameters for further processing using the request transformation policy. |
OpenID Connect | Specifies using the OpenID (ID) token to identify the client, extract the client's credentials from the ID token, and verify the client's identity against the specified list of applications in API Gateway. Select one of the Application Lookup condition: ![]() ![]() Note: You can use the client id and other parameters for further processing using the request transformation policy. |
SSL Certificate | Specifies using the SSL certificate to identify the client, extract the client's identity certificate, and verify the client's identity (certificate-based authentication) against the specified list of applications in API Gateway. The client certificate that is used to identify the client is supplied by the client to API Gateway during the SSL handshake over the transport layer. Select one of the Application Lookup condition: ![]() ![]() |
WS Security Username Token | This is applicable only for SOAP APIs. Specifies using the WS security username token to identify the application, extract the client's credentials (username token and password) from the WSSecurity SOAP message header, and verify the client's identity against the specified list of applications in API Gateway. Select one of the Application Lookup condition: ![]() ![]() Note: You can use the username for further processing using the request transformation policy. |
WS Security X.509 Certificate | This is applicable only for SOAP APIs. Specifies using the WS security X.509 certificate to identify the client, extract the client identity certificate from the WS-Security SOAP message header, and verify the client's identity against the specified list of applications inAPI Gateway. Select one of the Application Lookup condition: ![]() ![]() |
Payload Element | Specifies using the payload identifier to identify the client, extract the custom authentication credentials supplied in the request represented using the payload identifier, and verify the client's identity against the specified list of applications in API Gateway. Select one of the Application Lookup condition ![]() ![]() In the Payload identifier section, click Add payload identifier, provide the following information, and click Add. ![]() ![]() ![]() ![]() ![]() Note: You can add multiple namespace prefix and URI by clicking ![]() ![]() ![]() You can add multiple payload identifiers as required. Note: Only one payload identifier of each type is allowed. For example, you can add a maximum of three payload identifiers, each being of a different type. |