Create SOAP API access policy
Create an API access policy and map an authentication profile to restrict the authentication type for a SOAP API. For example, you can create an API access policy that allows only ID token authentication for a SOAP API.
Before you begin
- Make sure that an authentication profile is created. For more information, see Create an authentication profile.
- Role required: admin
Procedure
- Navigate to All > System Web Services > API Access Policies > SOAP API Access Policies.
- Click New.
-
On the form, fill in the fields.
Table 1. API Access Policies form Field Description Name Unique name of the API access policy. SOAP API SOAP API to which the access policy is applied. For example, GetProperty API. Application Scope of the application. Active Option to make the API access policy active. - In the Inbound Authentication section, double-click Insert a new row.
-
Select an inbound authentication profile from the list and click the save icon
.
For example, you can add Basic Auth, ID Token, Certificate based Auth, OAuth or WSSE Auth.- To add one or more inbound authentication profiles, click New to create a new profile.
-
Choose What Kind of authentication profiles?.
- Create standard http authentication profiles
- Create WSSE authentication profiles
-
To create a WSSE authentication profile, on the form, fill in the fields.
Table 2. WSSE Authentication Profile Field Description Name Unique name of the API access policy. Description Description of the authentication profile. Application Scope of the application. Active Option to make the API access policy active. Type WSSE Auth as authentication profile WSSE (Web Security). - After creating the authentication profile, save the record.
- Click Submit to submit the SOAP API access policy.