Create
Create
post/api/v1/policies
Create a policy.
Body Parameters
displayNamestring
The display name of the new policy.
descriptionstring
optional
The description of the new policy.
policyStepsmap
optional
The map of policy type to policy steps. The key is the stringified version of the enum. See other policies for examples.
policyTypeenum
optional
"POLICY_TYPE_UNSPECIFIED" OR "POLICY_TYPE_GRANT" OR "POLICY_TYPE_REVOKE" OR 3 more
The enum of the policy type.
Actions to occur after a policy finishes. As of now this is only valid on a certify policy to remediate a denied certification immediately.
reassignTasksToDelegatesboolean
optional
Allows reassigning tasks to delegates.
The rules field.
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 \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $CONDUCTORONE_SDK_API_KEY" \
-d '{
"displayName": "displayName"
}'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"
}
]
}
}