OrgsIDP Profiles

updateOrgIdpProfile

PUT
/api/v1/orgs/{org_id}/idpprofiles/{idpprofile_id}

Update an organization IDP profile, including its base profile and signature overwrite rules.

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Path Parameters

org_id*string
Formatuuid
idpprofile_id*string
Formatuuid

Request Body

application/json

Organization IDP profile with a base profile and targeted overwrite rules

base_profile?idp_profile_base_profile

Built-in IDP baseline profile inherited before applying overwrites. enum: critical, standard, strict.

Value in

  • "critical"
  • "standard"
  • "strict"
name?string

Display name of the IDP profile

overwrites?array<>

IDP signature override rules applied on top of the base profile

Response Body

curl -X PUT "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/idpprofiles/000000ab-00ab-00ab-00ab-0000000000ab" \  -H "Content-Type: application/json" \  -d '{    "base_profile": "strict",    "name": "relaxed",    "overwrites": [      {        "action": "alert",        "matching": {          "attack_name": [            "HTTP:INVALID:HDR-FIELD"          ],          "dst_subnet": [            "63.1.2.0/24"          ],          "severity": [            "major"          ]        }      }    ]  }'
{  "base_profile": "strict",  "created_time": 0,  "id": "874ca978-d736-4d4b-bc90-a49a29eec133",  "modified_time": 0,  "name": "relaxed",  "overwrites": [    {      "action": "alert",      "matching": {        "attack_name": [          "HTTP:INVALID:HDR-FIELD"        ],        "dst_subnet": [          "63.1.2.0/24"        ],        "severity": [          "major"        ]      }    }  ]}