Update Rule
PUT {{apiPath}}/environments/{{envID}}/propagation/rules/{{ruleID}}
The PUT /environments/{{envID}}/propagation/rules/{{ruleID}} operation updates the property values of the identified propagation rule resource.
Prerequisites
- See Identity Propagation (Provisioning) for important overview information.
See Propagation rule data model for full property descriptions.
If the rule is not a writeback rule:
| Property | Type | Required? |
|---|---|---|
active | Boolean | Optional |
configuration | Object | Required/Optional |
deprovision (Deprecated) | Boolean | Optional |
description | String | Optional |
groups.id | String | Required |
groups | Object[] | Optional |
name | String | Required |
populationExpression | String | Optional |
populations.id (Deprecated) | String[] | Optional |
Note: The configuration object is required for outbound LDAP Gateway stores (type LdapGateway) and inbound LDAP Gateway stores (where users are provisioned into PingOne), optional for all others and ignored if used.
This outbound LDAP configuration object is required for outbound LDAP Gateway stores (type LdapGateway).
| Property | Type | Required? |
|---|---|---|
BASE_DN | String | Required |
RDN_ATTRIBUTE | String | Required |
This inbound LDAP configuration object is required for inbound LDAP Gateway stores (where users are provisioned into PingOne).
If AUTHENTICATE_VIA_AD_LDAP is false, then the GATEWAY_USER_TYPE_* configuration attributes are optional and ignored if used. Note that USERS_BASE_DN is always required and unaffected by the value of AUTHENTICATE_VIA_AD_LDAP.
AUTHENTICATE_VIA_AD_LDAP can only be true if a userTypes object is configured in the gateway as returned by Read One Gateway. The remaining configuration attributes are required and must exactly match the corresponding attribute in the userTypes array object.
Note: The userTypes object must not have a newUserLookup property if it is to be used with AUTHENTICATE_VIA_AD_LDAP as true.
| Property | Type | Required? |
|---|---|---|
AUTHENTICATE_VIA_AD_LDAP | Boolean | Required |
GATEWAY_USER_TYPE_ALLOW_PASSWORD_CHANGES | Boolean | Required/Optional |
GATEWAY_USER_TYPE_CORRELATION_ATTRIBUTES | String | Required/Optional |
GATEWAY_USER_TYPE_ID | String | Required/Optional |
GATEWAY_USER_TYPE_NAME | String | Required/Optional |
GATEWAY_USER_TYPE_PASSWORD_AUTHORITY | String | Required/Optional |
USERS_BASE_DN | String | Required |
If the rule is a writeback rule:
| Property | Type | Required? |
|---|---|---|
description | String | Optional |
name | String | Required |
Request Body
{"plan"=>{"id"=>"{{planID}}"}, "name"=>"updated rule", "environment"=>{"id"=>"{{envID}}"}, "sourceStore"=>{"id"=>"{{sourceStoreID}}"}, "targetStore"=>{"id"=>"{{targetStoreID}}"}, "groups"=>[{"id"=>"{{groupID}}"}], "populationExpression"=>"population.id eq \"{{popID}}\""}
RESPONSES
status: OK
{"id":"66cc421f-8b1e-4b82-8f0b-20a1b7eec998","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"createdAt":"2023-05-22T18:08:32.784Z","updatedAt":"2023-05-22T18:36:51.304Z","plan":{"id":"9b0f46a7-1987-4c80-8dfd-b4f34a96d216"},"sourceStore":{"id":"01f31fb7-6e39-4678-9420-e3b2e7358fdd"},"targetStore":{"id":"d43ab23a-0c41-46b7-9468-66b52561636e"},"name":"updated rule","active":false,"populationExpression":"population.id eq \"cb3ef0a0-0ff5-4f60-ae82-4ae65d9d0e3a\"","deprovision":false,"groups":[{"id":"1da23f50-4258-43e4-93cd-a7e9e9c5e167"}],"_links":{"create":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/plans/9b0f46a7-1987-4c80-8dfd-b4f34a96d216/rules"},"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/rules/66cc421f-8b1e-4b82-8f0b-20a1b7eec998"},"update":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/rules/66cc421f-8b1e-4b82-8f0b-20a1b7eec998"},"delete":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/rules/66cc421f-8b1e-4b82-8f0b-20a1b7eec998"}}}