List

List Automations

get/api/v1/automations

Invokes the c1.api.automations.v1.AutomationService.ListAutomations method.

Returns

listarray of idstringappIdstringautomationStepsarray of AutomationStepcontextAutomationContextcreatedAtstringcurrentVersionstringdescriptionstringdisplayNamestringdraftAutomationStepsarray of AutomationStepdraftTriggersarray of AutomationTriggerenabledbooleanisDraftbooleanlastExecutedAtstringtriggersarray of AutomationTriggerAutomation

optional

The list field.

nextPageTokenstring

optional

The nextPageToken field.

Request example cURL

curl https://{tenantDomain}.conductor.one/api/v1/automations \
    -H "Authorization: Bearer $CONDUCTORONE_SDK_API_KEY"

200 Example

{
  "list": [
    {
      "appId": "appId",
      "automationSteps": [
        {
          "connectorAction": {
            "actionName": "actionName",
            "argsTemplate": {
              "foo": "bar"
            },
            "connectorRef": {
              "id": "id",
              "appId": "appId"
            }
          },
          "connectorCreateAccount": {
            "connectorRef": {
              "id": "id",
              "appId": "appId"
            },
            "userIdCel": "userIdCel",
            "userProperties": {
              "displayNameCel": "displayNameCel",
              "emailCel": "emailCel",
              "profileAttributeCel": "profileAttributeCel",
              "usernameCel": "usernameCel"
            }
          },
          "createAccessReview": {
            "accessReviewTemplateCel": "accessReviewTemplateCel",
            "accessReviewTemplateId": "accessReviewTemplateId",
            "userIdsCel": "userIdsCel",
            "userRefs": [
              {
                "id": "id"
              }
            ],
            "useSubjectUser": true
          },
          "createRevokeTasks": {
            "appEntitlementRefs": [
              {
                "id": "id",
                "appId": "appId"
              }
            ],
            "appEntitlementRefsCel": "appEntitlementRefsCel",
            "revokeAll": true,
            "userIdCel": "userIdCel",
            "userRef": {
              "id": "id"
            },
            "useSubjectUser": true
          },
          "removeFromDelegation": {
            "replacementUserIdCel": "replacementUserIdCel",
            "replacementUserRef": {
              "id": "id"
            },
            "userIdCel": "userIdCel",
            "userRef": {
              "id": "id"
            },
            "useSubjectUser": true
          },
          "runAutomation": {
            "automationTemplateIdCel": "automationTemplateIdCel",
            "automationTemplateRef": {
              "id": "id"
            },
            "context": {
              "context": {
                "foo": "bar"
              }
            }
          },
          "sendEmail": {
            "body": "body",
            "subject": "subject",
            "title": "title",
            "userIdsCel": "userIdsCel",
            "userRefs": [
              {
                "id": "id"
              }
            ],
            "useSubjectUser": true
          },
          "skipIfTrueCel": "skipIfTrueCel",
          "stepDisplayName": "stepDisplayName",
          "stepName": "stepName",
          "taskAction": {
            "close": {
              "userIdCel": "userIdCel",
              "userRef": {
                "id": "id"
              },
              "useSubjectUser": true
            },
            "reassign": {
              "assigneeUserIdCel": "assigneeUserIdCel",
              "assigneeUserRef": {
                "id": "id"
              },
              "subjectUserIdCel": "subjectUserIdCel",
              "subjectUserRef": {
                "id": "id"
              },
              "useSubjectUser": true
            },
            "taskTypes": [
              "TASK_TYPE_UNSPECIFIED"
            ]
          },
          "unenrollFromAllAccessProfiles": {
            "catalogIds": [
              "string"
            ],
            "catalogIdsCel": "catalogIdsCel",
            "userIdsCel": "userIdsCel",
            "userRefs": [
              {
                "id": "id"
              }
            ],
            "useSubjectUser": true
          },
          "updateUser": {
            "userIdCel": "userIdCel",
            "userRef": {
              "id": "id"
            },
            "userStatusCel": "userStatusCel",
            "userStatusEnum": "UNKNOWN",
            "useSubjectUser": true
          },
          "waitForDuration": {
            "duration": "duration"
          },
          "webhook": {
            "payload": {
              "foo": "bar"
            },
            "webhookId": "webhookId",
            "webhookIdCel": "webhookIdCel"
          }
        }
      ],
      "context": {
        "context": {
          "foo": "bar"
        }
      },
      "createdAt": "2019-12-27T18:11:19.117Z",
      "currentVersion": "currentVersion",
      "description": "description",
      "displayName": "displayName",
      "draftAutomationSteps": [
        {
          "connectorAction": {
            "actionName": "actionName",
            "argsTemplate": {
              "foo": "bar"
            },
            "connectorRef": {
              "id": "id",
              "appId": "appId"
            }
          },
          "connectorCreateAccount": {
            "connectorRef": {
              "id": "id",
              "appId": "appId"
            },
            "userIdCel": "userIdCel",
            "userProperties": {
              "displayNameCel": "displayNameCel",
              "emailCel": "emailCel",
              "profileAttributeCel": "profileAttributeCel",
              "usernameCel": "usernameCel"
            }
          },
          "createAccessReview": {
            "accessReviewTemplateCel": "accessReviewTemplateCel",
            "accessReviewTemplateId": "accessReviewTemplateId",
            "userIdsCel": "userIdsCel",
            "userRefs": [
              {
                "id": "id"
              }
            ],
            "useSubjectUser": true
          },
          "createRevokeTasks": {
            "appEntitlementRefs": [
              {
                "id": "id",
                "appId": "appId"
              }
            ],
            "appEntitlementRefsCel": "appEntitlementRefsCel",
            "revokeAll": true,
            "userIdCel": "userIdCel",
            "userRef": {
              "id": "id"
            },
            "useSubjectUser": true
          },
          "removeFromDelegation": {
            "replacementUserIdCel": "replacementUserIdCel",
            "replacementUserRef": {
              "id": "id"
            },
            "userIdCel": "userIdCel",
            "userRef": {
              "id": "id"
            },
            "useSubjectUser": true
          },
          "runAutomation": {
            "automationTemplateIdCel": "automationTemplateIdCel",
            "automationTemplateRef": {
              "id": "id"
            },
            "context": {
              "context": {
                "foo": "bar"
              }
            }
          },
          "sendEmail": {
            "body": "body",
            "subject": "subject",
            "title": "title",
            "userIdsCel": "userIdsCel",
            "userRefs": [
              {
                "id": "id"
              }
            ],
            "useSubjectUser": true
          },
          "skipIfTrueCel": "skipIfTrueCel",
          "stepDisplayName": "stepDisplayName",
          "stepName": "stepName",
          "taskAction": {
            "close": {
              "userIdCel": "userIdCel",
              "userRef": {
                "id": "id"
              },
              "useSubjectUser": true
            },
            "reassign": {
              "assigneeUserIdCel": "assigneeUserIdCel",
              "assigneeUserRef": {
                "id": "id"
              },
              "subjectUserIdCel": "subjectUserIdCel",
              "subjectUserRef": {
                "id": "id"
              },
              "useSubjectUser": true
            },
            "taskTypes": [
              "TASK_TYPE_UNSPECIFIED"
            ]
          },
          "unenrollFromAllAccessProfiles": {
            "catalogIds": [
              "string"
            ],
            "catalogIdsCel": "catalogIdsCel",
            "userIdsCel": "userIdsCel",
            "userRefs": [
              {
                "id": "id"
              }
            ],
            "useSubjectUser": true
          },
          "updateUser": {
            "userIdCel": "userIdCel",
            "userRef": {
              "id": "id"
            },
            "userStatusCel": "userStatusCel",
            "userStatusEnum": "UNKNOWN",
            "useSubjectUser": true
          },
          "waitForDuration": {
            "duration": "duration"
          },
          "webhook": {
            "payload": {
              "foo": "bar"
            },
            "webhookId": "webhookId",
            "webhookIdCel": "webhookIdCel"
          }
        }
      ],
      "draftTriggers": [
        {
          "appUserCreated": {
            "appId": "appId",
            "appIdCel": "appIdCel"
          },
          "appUserUpdated": {
            "appId": "appId",
            "appIdCel": "appIdCel"
          },
          "condition": "condition",
          "manual": {},
          "usageBasedRevocation": {
            "appId": "appId",
            "enabledAt": "2019-12-27T18:11:19.117Z",
            "excludedGroupRefs": [
              {
                "id": "id",
                "appId": "appId"
              }
            ],
            "excludedUserRefs": [
              {
                "id": "id"
              }
            ],
            "includeUsersWithNoActivity": true,
            "runDelayed": {
              "coldStartDelayDays": 0
            },
            "runImmediately": {},
            "targetedAppUserTypes": [
              "APP_USER_TYPE_UNSPECIFIED"
            ],
            "targetedEntitlementRefs": [
              {
                "id": "id",
                "appId": "appId"
              }
            ],
            "unusedForDays": 0
          },
          "userProfileChange": {
            "profileAttributeCel": "profileAttributeCel",
            "profileAttributeKey": "profileAttributeKey"
          }
        }
      ],
      "enabled": true,
      "isDraft": true,
      "lastExecutedAt": "2019-12-27T18:11:19.117Z",
      "triggers": [
        {
          "appUserCreated": {
            "appId": "appId",
            "appIdCel": "appIdCel"
          },
          "appUserUpdated": {
            "appId": "appId",
            "appIdCel": "appIdCel"
          },
          "condition": "condition",
          "manual": {},
          "usageBasedRevocation": {
            "appId": "appId",
            "enabledAt": "2019-12-27T18:11:19.117Z",
            "excludedGroupRefs": [
              {
                "id": "id",
                "appId": "appId"
              }
            ],
            "excludedUserRefs": [
              {
                "id": "id"
              }
            ],
            "includeUsersWithNoActivity": true,
            "runDelayed": {
              "coldStartDelayDays": 0
            },
            "runImmediately": {},
            "targetedAppUserTypes": [
              "APP_USER_TYPE_UNSPECIFIED"
            ],
            "targetedEntitlementRefs": [
              {
                "id": "id",
                "appId": "appId"
              }
            ],
            "unusedForDays": 0
          },
          "userProfileChange": {
            "profileAttributeCel": "profileAttributeCel",
            "profileAttributeKey": "profileAttributeKey"
          }
        }
      ]
    }
  ],
  "nextPageToken": "nextPageToken"
}