Update
Update
post/api/v1/policies/{id}
Update a policy by providing a policy object and an update mask.
Path Parameters
idstring
The ID of the Policy.
Body Parameters
policyidstringcreatedAtstringdeletedAtstringdescriptionstringdisplayNamestringpolicyStepsmappolicyTypeenumpostActionsarray of PolicyPostActionsreassignTasksToDelegatesbooleanrulesarray of RulesystemBuiltinbooleanupdatedAtstringPolicy
optional
A policy describes the behavior of the ConductorOne system when processing a task. You can describe the type, approvers, fallback behavior, and escalation processes.
updateMaskstring
optional
Returns
policyidstringcreatedAtstringdeletedAtstringdescriptionstringdisplayNamestringpolicyStepsmappolicyTypeenumpostActionsarray of PolicyPostActionsreassignTasksToDelegatesbooleanrulesarray of RulesystemBuiltinbooleanupdatedAtstringPolicy
optional
A policy describes the behavior of the ConductorOne system when processing a task. You can describe the type, approvers, fallback behavior, and escalation processes.
Request example cURL
curl https://{tenantDomain}.conductor.one/api/v1/policies/$ID \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $CONDUCTORONE_SDK_API_KEY"200 Example
{
"policy": {
"description": "description",
"displayName": "displayName",
"policySteps": {
"foo": {
"steps": [
{
"accept": {
"acceptMessage": "acceptMessage"
},
"approval": {
"agent": {
"agentMode": "APPROVAL_AGENT_MODE_UNSPECIFIED",
"agentUserId": "agentUserId",
"instructions": "instructions",
"policyIds": [
"string"
]
},
"allowedReassignees": [
"string"
],
"allowReassignment": true,
"appOwners": {
"allowSelfApproval": true
},
"entitlementOwners": {
"allowSelfApproval": true,
"fallback": true,
"fallbackUserIds": [
"string"
]
},
"escalation": {
"escalationComment": "escalationComment",
"expiration": "expiration",
"reassignToApprovers": {
"approverIds": [
"string"
]
},
"replacePolicy": {
"policyId": "policyId"
}
},
"escalationEnabled": true,
"expression": {
"allowSelfApproval": true,
"expressions": [
"string"
],
"fallback": true,
"fallbackUserIds": [
"string"
]
},
"group": {
"allowSelfApproval": true,
"appGroupId": "appGroupId",
"appId": "appId",
"fallback": true,
"fallbackUserIds": [
"string"
]
},
"manager": {
"allowSelfApproval": true,
"fallback": true,
"fallbackUserIds": [
"string"
]
},
"requireApprovalReason": true,
"requireDenialReason": true,
"requireReassignmentReason": true,
"requiresStepUpProviderId": "requiresStepUpProviderId",
"resourceOwners": {
"allowSelfApproval": true,
"fallback": true,
"fallbackUserIds": [
"string"
]
},
"self": {
"fallback": true,
"fallbackUserIds": [
"string"
]
},
"users": {
"allowSelfApproval": true,
"userIds": [
"string"
]
},
"webhook": {
"webhookId": "webhookId"
}
},
"provision": {
"assigned": true,
"provisionPolicy": {
"connector": {
"account": {
"config": {
"foo": "bar"
},
"connectorId": "connectorId",
"doNotSave": {},
"saveToVault": {
"vaultIds": [
"string"
]
},
"schemaId": "schemaId"
},
"defaultBehavior": {
"connectorId": "connectorId"
},
"deleteAccount": {
"connectorId": "connectorId"
}
},
"delegated": {
"appId": "appId",
"entitlementId": "entitlementId",
"implicit": true
},
"externalTicket": {
"appId": "appId",
"connectorId": "connectorId",
"externalTicketProvisionerConfigId": "externalTicketProvisionerConfigId",
"instructions": "instructions"
},
"manual": {
"instructions": "instructions",
"userIds": [
"string"
]
},
"unconfigured": {},
"webhook": {
"webhookId": "webhookId"
}
},
"provisionTarget": {
"appEntitlementId": "appEntitlementId",
"appId": "appId",
"appUserId": "appUserId",
"grantDuration": "grantDuration"
}
},
"reject": {
"rejectMessage": "rejectMessage"
},
"wait": {
"commentOnFirstWait": "commentOnFirstWait",
"commentOnTimeout": "commentOnTimeout",
"condition": {
"condition": "condition"
},
"name": "name",
"timeoutDuration": "timeoutDuration"
}
}
]
}
},
"policyType": "POLICY_TYPE_UNSPECIFIED",
"postActions": [
{
"certifyRemediateImmediately": true
}
],
"reassignTasksToDelegates": true,
"rules": [
{
"condition": "condition",
"policyKey": "policyKey"
}
]
}
}