Update rule

PUT endpoint for updating an existing SAML provisioning rule, with request headers, body structure, and known response limitations.

Updates an existing SAML provisioning rule.

Endpoint

PUT /api/Rule

Request body

Field	Type	Required	Description
ruleId	Integer	Yes	The unique identifier of the rule to update
partitionGlobalId	GUID	Yes	The global identifier of the organization. For steps on retrieving partitionGlobalId, refer to Retrieving partitionGlobalId for API use.
name	String	Yes	Updated name of the rule
description	String	No	Updated description
enabled	Boolean	Yes	Whether the rule is active
definition	String	No	The rule definition

Request headers

--header 'Authorization: Bearer {access_token}'
--header 'Content-Type: application/json'

Responses

Note:

The Update Rule endpoint does not return a RuleDto. Assigned groups are not returned.

{
  "id": 3685,
  "name": "Test",
  "description": "Test",
  "enabled": true,
  "partitionId": 28728,
  "definition": "{\"GroupsToAssign\":[\"4d161738-7204-4794-b839-8f7fed28366c\"],\"Conditions\":[]}",
  "creationTime": "2026-01-29T16:09:41.7203623",
  "lastModificationTime": "2026-01-29T16:11:18.691478Z"
}

Example request

{
  "ruleId": 3685,
  "partitionGlobalId": "{{prtId}}",
  "name": "Test",
  "description": "Test",
  "enabled": true,
  "definition": "{\"GroupsToAssign\":[\"4d161738-7204-4794-b839-8f7fed28366c\"],\"Conditions\":[]}"
}

Error responses

• 400 Bad Request: Invalid request body or validation errors
• 401 Unauthorized: Missing or invalid authentication token
• 403 Forbidden: Insufficient permissions
• 404 Not Found: Organization or rule does not exist