Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

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: api_service_admin, adaptive_auth_policy_admin

Procedure

  1. Navigate to All > System Web Services > API Access Policies > SOAP API Access Policies.

  2. Click New.

  3. On the form, fill in the fields.

    FieldDescription
    NameUnique name of the API access policy.
    SOAP APISOAP API to which the access policy is applied. For example, GetProperty API.
    ApplicationScope of the application.
    ActiveOption to make the API access policy active.
  4. In the Inbound Authentication section, double-click Insert a new row.

  5. Select an inbound authentication profile from the list and click the save icon

Image omitted: green-checkmark.png
save icon.
For example, you can add **Basic Auth**, **ID Token**, **Certificate based Auth**, **OAuth** or **WSSE Auth**.
Image omitted: create-soap-api-policy.png
SOAP API Access Policy
1.  To add one or more inbound authentication profiles, click **New** to create a new profile.

2.  Choose **What Kind of authentication profiles?**.

    -   **Create standard http authentication profiles**
    -   **Create WSSE authentication profiles**
Image omitted: auth-profile.png
Authentication Profile
3.  To create a WSSE authentication profile, on the form, fill in the fields.

    |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\).|
Image omitted: wsse-profile.png
WSSE Authentication Profile
4.  After creating the authentication profile, save the record.
  1. Click Submit to submit the SOAP API access policy.