Workflows API (2.17.0)

Download OpenAPI specification:Download

ILM: info@otilm.com URL: https://www.otilm.com License: MIT License

REST API for managing workflows resources in the platform

ILM Documentation

Workflow Actions Management

Workflow Actions Management API

Get Execution Details

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

executionUuid

required

string

Execution UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "setField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"notificationProfileUuid": "string",
"notificationProfileName": "string",
"data": null
}
]
}

Update Execution

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

executionUuid

required

string

Execution UUID

Request Body schema: application/json
required

description	string Description of the execution
required	Array of objects (ExecutionItemRequestDto) List of the execution items to add to execution

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"notificationProfileUuid": "string",
"data": null
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "setField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"notificationProfileUuid": "string",
"notificationProfileName": "string",
"data": null
}
]
}

Delete Execution

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

executionUuid

required

string

Execution UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Get Action Details

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

actionUuid

required

string

Action UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"resource": "NONE",
"executions": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "setField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"notificationProfileUuid": "string",
"notificationProfileName": "string",
"data": null
}
]
}
]
}

Update Action

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

actionUuid

required

string

Action UUID

Request Body schema: application/json
required

description	string Description of the action
executionsUuids required	Array of strings List of UUIDs of existing executions to add to the action

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"executionsUuids": ["string"
]
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"resource": "NONE",
"executions": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "setField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"notificationProfileUuid": "string",
"notificationProfileName": "string",
"data": null
}
]
}
]
}

Delete Action

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

actionUuid

required

string

Action UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

List executions

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

query Parameters

resource

string (Resource)

Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" "vaults" "vaultProfiles" "secrets"

Responses

Response samples

200
400
403

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "setField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"notificationProfileUuid": "string",
"notificationProfileName": "string",
"data": null
}
]
}
]

Create Execution

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Request Body schema: application/json
required

name required	string Name of the execution
description	string Description of the execution
type required	string (ExecutionType) Enum: "setField" "sendNotification" Type of the execution
resource required	string (Resource) Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" "vaults" "vaultProfiles" "secrets" Resource associated with the execution
required	Array of objects (ExecutionItemRequestDto) List of the execution items to add to execution

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"type": "setField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"notificationProfileUuid": "string",
"data": null
}
]
}

Response samples

201
400
403

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "setField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"notificationProfileUuid": "string",
"notificationProfileName": "string",
"data": null
}
]
}

List Actions

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

query Parameters

resource

string (Resource)

Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" "vaults" "vaultProfiles" "secrets"

Responses

Response samples

200
400
403

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"resource": "NONE"
}
]

Create Action

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Request Body schema: application/json
required

name required	string Name of the action
description	string Description of the action
resource required	string (Resource) Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" "vaults" "vaultProfiles" "secrets" Resource associated with the action
executionsUuids required	Array of strings List of UUIDs of existing executions to add to the action

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"resource": "NONE",
"executionsUuids": ["string"
]
}

Response samples

201
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"resource": "NONE",
"executions": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "setField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"notificationProfileUuid": "string",
"notificationProfileName": "string",
"data": null
}
]
}
]
}

Workflow Rules Management

Workflow Rules Management API

Get Rule details

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

ruleUuid

required

string

Rule UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"resource": "NONE",
"conditions": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "checkField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
}
]
}

Update Rule

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

ruleUuid

required

string

Rule UUID

Request Body schema: application/json
required

description	string Description of the Rule
conditionsUuids required	Array of strings List of UUIDs of existing conditions to add to the rule

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"conditionsUuids": ["string"
]
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"resource": "NONE",
"conditions": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "checkField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
}
]
}

Delete Rule

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

ruleUuid

required

string

Rule UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Get Condition details

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

conditionUuid

required

string

Condition UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "checkField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
}

Update Condition

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

conditionUuid

required

string

Condition UUID

Request Body schema: application/json
required

description	string Description of the condition
required	Array of objects (ConditionItemRequestDto) List of the condition items to add to condition

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "checkField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
}

Delete Condition

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

conditionUuid

required

string

Condition UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

List Rules

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

query Parameters

resource

string (Resource)

Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" "vaults" "vaultProfiles" "secrets"

Responses

Response samples

200
400
403

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"resource": "NONE"
}
]

Create Rule

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Request Body schema: application/json
required

name required	string Name of the rule
description	string Description of the rule
resource required	string (Resource) Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" "vaults" "vaultProfiles" "secrets" Resource associated with the rule
conditionsUuids required	Array of strings List of UUIDs of existing conditions to add to the rule

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"resource": "NONE",
"conditionsUuids": ["string"
]
}

Response samples

201
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"resource": "NONE",
"conditions": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "checkField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
}
]
}

List Conditions

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

query Parameters

resource

string (Resource)

Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" "vaults" "vaultProfiles" "secrets"

Responses

Response samples

200
400
403

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "checkField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
}
]

Create Condition

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Request Body schema: application/json
required

name required	string Name of the condition
description	string Description of the condition
type required	string (ConditionType) Value: "checkField" Type of the condition
resource required	string (Resource) Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" "vaults" "vaultProfiles" "secrets" Resource associated with the condition
required	Array of objects (ConditionItemRequestDto) List of the condition items to add to condition

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"type": "checkField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
}

Response samples

201
400
403

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "checkField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
}

Workflow Triggers Management

Workflow Triggers Management API

Get Trigger details

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

triggerUuid

required

string

Trigger UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "event",
"resource": "NONE",
"ignoreTrigger": true,
"event": "certificate_status_changed",
"rules": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"resource": "NONE",
"conditions": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "checkField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
}
]
}
],
"actions": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"resource": "NONE",
"executions": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "setField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"notificationProfileUuid": "string",
"notificationProfileName": "string",
"data": null
}
]
}
]
}
]
}

Update Trigger

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

triggerUuid

required

string

Trigger UUID

Request Body schema: application/json
required

description	string Description of the trigger
type	string (TriggerType) Enum: "event" "manual" Type of the trigger
resource required	string (Resource) Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" "vaults" "vaultProfiles" "secrets" Resource associated with the trigger
ignoreTrigger required	boolean Flag if to ignore object when trigger rules are matched and do not perform any actions and stop evaluating other triggers. Based on context could have other implications to object processing. If ignore is set, trigger does not have any actions.
event	string (ResourceEvent) Enum: "certificate_status_changed" "certificate_action_performed" "certificate_discovered" "certificate_expiring" "certificate_not_compliant" "discovery_finished" "approval_requested" "approval_closed" "scheduled_job_finished" Event that trigger can be assigned to
rulesUuids	Array of strings List of UUIDs of existing rules to add to the trigger
actionsUuids	Array of strings List of UUIDs of existing actions to add to the trigger

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"type": "event",
"resource": "NONE",
"ignoreTrigger": true,
"event": "certificate_status_changed",
"rulesUuids": ["string"
],
"actionsUuids": ["string"
]
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "event",
"resource": "NONE",
"ignoreTrigger": true,
"event": "certificate_status_changed",
"rules": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"resource": "NONE",
"conditions": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "checkField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
}
]
}
],
"actions": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"resource": "NONE",
"executions": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "setField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"notificationProfileUuid": "string",
"notificationProfileName": "string",
"data": null
}
]
}
]
}
]
}

Delete Trigger

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

triggerUuid

required

string

Trigger UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

List Triggers

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

query Parameters

resource

string (Resource)

Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" "vaults" "vaultProfiles" "secrets"

Responses

Response samples

200
400
403

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "event",
"resource": "NONE",
"ignoreTrigger": true,
"event": "certificate_status_changed"
}
]

Create Trigger

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Request Body schema: application/json
required

name required	string Name of the trigger
description	string Description of the trigger
type	string (TriggerType) Enum: "event" "manual" Type of the trigger
resource required	string (Resource) Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" "vaults" "vaultProfiles" "secrets" Resource associated with the trigger
ignoreTrigger required	boolean Flag if to ignore object when trigger rules are matched and do not perform any actions and stop evaluating other triggers. Based on context could have other implications to object processing. If ignore is set, trigger does not have any actions.
event	string (ResourceEvent) Enum: "certificate_status_changed" "certificate_action_performed" "certificate_discovered" "certificate_expiring" "certificate_not_compliant" "discovery_finished" "approval_requested" "approval_closed" "scheduled_job_finished" Event that trigger can be assigned to
rulesUuids	Array of strings List of UUIDs of existing rules to add to the trigger
actionsUuids	Array of strings List of UUIDs of existing actions to add to the trigger

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"type": "event",
"resource": "NONE",
"ignoreTrigger": true,
"event": "certificate_status_changed",
"rulesUuids": ["string"
],
"actionsUuids": ["string"
]
}

Response samples

201
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "event",
"resource": "NONE",
"ignoreTrigger": true,
"event": "certificate_status_changed",
"rules": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"resource": "NONE",
"conditions": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "checkField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
}
]
}
],
"actions": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"resource": "NONE",
"executions": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "setField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"notificationProfileUuid": "string",
"notificationProfileName": "string",
"data": null
}
]
}
]
}
]
}

Associate event with triggers

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Request Body schema: application/json
required

event required	string (ResourceEvent) Enum: "certificate_status_changed" "certificate_action_performed" "certificate_discovered" "certificate_expiring" "certificate_not_compliant" "discovery_finished" "approval_requested" "approval_closed" "scheduled_job_finished" Resource event
resource required	string (Resource) Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" "vaults" "vaultProfiles" "secrets" Event triggers association resource
objectUuid required	string <uuid> Event triggers association object UUID
triggerUuids required	Array of strings <uuid> [ items <uuid > ] List of triggers associated with event

Responses

Request samples

Payload

Content type

application/json

{"event": "certificate_status_changed",
"resource": "NONE",
"objectUuid": "099486af-28ad-4686-8639-67f5d62fa89c",
"triggerUuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Get Trigger History

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

triggerUuid required	string Trigger UUID
associationObjectUuid required	string Trigger Association Object UUID

Responses

Response samples

200
400
403

Content type

application/json

[{"uuid": "string",
"triggerUuid": "string",
"objectUuid": "string",
"referenceObjectUuid": "string",
"conditionsMatched": true,
"actionsPerformed": true,
"triggeredAt": "2019-08-24T14:15:22Z",
"message": "string",
"records": [{"message": "string",
"condition": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "checkField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
},
"execution": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "setField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"notificationProfileUuid": "string",
"notificationProfileName": "string",
"data": null
}
]
}
}
]
}
]

Get Trigger History Summary

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

associationObjectUuid

required

string

Trigger Association Object UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"associationResource": "NONE",
"associationObjectUuid": "string",
"objectsResource": "NONE",
"objectsEvaluated": 0,
"objectsMatched": 0,
"objectsIgnored": 0,
"objects": [{"objectUuid": "099486af-28ad-4686-8639-67f5d62fa89c",
"referenceObjectUuid": "7a517f58-be85-4019-b82a-683e436bf748",
"matched": true,
"ignored": true,
"triggers": [{"triggerUuid": "ca4fb7a3-f773-4484-9f51-9819f1ae7343",
"triggerName": "string",
"triggeredAt": "2019-08-24T14:15:22Z",
"message": "string",
"records": [{"message": "string",
"condition": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "checkField",
"resource": "NONE",
"items": [{"fieldSource": null,
"fieldIdentifier": null,
"operator": null,
"value": null
}
]
},
"execution": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "setField",
"resource": "NONE",
"items": [{"fieldSource": null,
"fieldIdentifier": null,
"notificationProfileUuid": null,
"notificationProfileName": null,
"data": null
}
]
}
}
]
}
]
}
]
}

Get event triggers associations for resource object

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

resource

required

string (Resource)

Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" "vaults" "vaultProfiles" "secrets"

Resource

associationObjectUuid

required

string <uuid>

Association object UUID

Responses

Response samples

200
400
403

Content type

application/json

{"property1": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"property2": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Workflows API (2.17.0)

Workflow Actions Management

Get Execution Details

Authorizations:

path Parameters

Responses

Response samples

Update Execution

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete Execution

Authorizations:

path Parameters

Responses

Response samples

Get Action Details

Authorizations:

path Parameters

Responses

Response samples

Update Action

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete Action

Authorizations:

path Parameters

Responses

Response samples

List executions

Authorizations:

query Parameters

Responses

Response samples

Create Execution

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

List Actions

Authorizations:

query Parameters

Responses

Response samples

Create Action

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Workflow Rules Management

Get Rule details

Authorizations:

path Parameters

Responses

Response samples

Update Rule

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete Rule

Authorizations:

path Parameters

Responses

Response samples

Get Condition details

Authorizations:

path Parameters

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required