Skip to content
ConductorOne Docs
  • Auto
  • Light
  • Dark
Get Started

Automations

Automations

Automations

Create Automation
post/api/v1/automations
Get Automation
get/api/v1/automations/{id}
Update Automation
post/api/v1/automations/{id}
List Automations
get/api/v1/automations
Delete Automation
delete/api/v1/automations/{id}
Execute Automation
post/api/v1/automations/{id}/execute
Search Automations
post/api/v1/automations/search
Automation
Automationobject

The Automation message.

ShowShow
idstring
optional

The id field.

appIdstring
optional

the app id this workflow_template belongs to

automationStepsarray of connectorActionobjectconnectorCreateAccountobjectcreateAccessReviewobjectcreateRevokeTasksobjectremoveFromDelegationobjectrunAutomationobjectsendEmailobjectskipIfTrueCelstringstepDisplayNamestringstepNamestringtaskActionobjectunenrollFromAllAccessProfilesobjectupdateUserobjectwaitForDurationobjectwebhookobjectAutomationStep
optional

The automationSteps field.

contextcontextmapAutomationContext
optional

The AutomationContext message.

createdAtstring
optional
formatdate-time
currentVersionstring
optional

The currentVersion field.

formatint64
descriptionstring
optional

The description field.

displayNamestring
optional

The displayName field.

draftAutomationStepsarray of connectorActionobjectconnectorCreateAccountobjectcreateAccessReviewobjectcreateRevokeTasksobjectremoveFromDelegationobjectrunAutomationobjectsendEmailobjectskipIfTrueCelstringstepDisplayNamestringstepNamestringtaskActionobjectunenrollFromAllAccessProfilesobjectupdateUserobjectwaitForDurationobjectwebhookobjectAutomationStep
optional

The draftAutomationSteps field.

draftTriggersarray of appUserCreatedobjectappUserUpdatedobjectconditionstringmanualunknownusageBasedRevocationobjectuserProfileChangeobjectAutomationTrigger
optional

The draftTriggers field.

enabledboolean
optional

The enabled field.

isDraftboolean
optional

The isDraft field.

lastExecutedAtstring
optional
formatdate-time
triggersarray of appUserCreatedobjectappUserUpdatedobjectconditionstringmanualunknownusageBasedRevocationobjectuserProfileChangeobjectAutomationTrigger
optional

The triggers field.

Automation Context
AutomationContextobject

The AutomationContext message.

ShowShow
contextmap
optional
Automation Step
AutomationStepobject

The AutomationStep message.

This message contains a oneof named kind. Only a single field of the following list may be set at a time:

  • createAccessReview
  • waitForDuration
  • unenrollFromAllAccessProfiles
  • createRevokeTasks
  • sendEmail
  • removeFromDelegation
  • runAutomation
  • updateUser
  • taskAction
  • webhook
  • connectorAction
  • connectorCreateAccount
ShowShow
connectorActionobject
optional

The ConnectorAction message.

This message contains a oneof named connector_identifier. Only a single field of the following list may be set at a time:

  • connectorRef
Hide ParametersShow Parameters
actionNamestring
optional

The actionName field.

argsTemplatemap
optional
connectorRefidstringappIdstringConnectorRef
optional

The ConnectorRef message.

connectorCreateAccountobject
optional

The ConnectorCreateAccount message.

This message contains a oneof named create_account_arguments. Only a single field of the following list may be set at a time:

  • userIdCel
  • userProperties
Hide ParametersShow Parameters
connectorRefidstringappIdstringConnectorRef
optional

The ConnectorRef message.

userIdCelstring
optional

The userIdCel field. This field is part of the create_account_arguments oneof. See the documentation for c1.api.automations.v1.ConnectorCreateAccount for more details.

userPropertiesobject
optional

The UserProperties message.

Hide ParametersShow Parameters
displayNameCelstring
optional

The displayNameCel field.

emailCelstring
optional

The emailCel field.

profileAttributeCelstring
optional

The profileAttributeCel field.

usernameCelstring
optional

The usernameCel field.

createAccessReviewobject
optional

The CreateAccessReview message.

Hide ParametersShow Parameters
accessReviewTemplateCelstring
optional

The accessReviewTemplateCel field.

accessReviewTemplateIdstring
optional

The accessReviewTemplateId field.

userIdsCelstring
optional

The userIdsCel field.

userRefsarray of idstringUserRef
optional

The userRefs field.

useSubjectUserboolean
optional

If true, the step will use the subject user of the automation as the subject.

createRevokeTasksobject
optional

The CreateRevokeTasks message.

Hide ParametersShow Parameters
appEntitlementRefsarray of idstringappIdstringAppEntitlementRef
optional

The appEntitlementRefs field.

appEntitlementRefsCelstring
optional

The appEntitlementRefsCel field.

revokeAllboolean
optional

The revokeAll field.

userIdCelstring
optional

The userIdCel field.

userRefidstringUserRef
optional

A reference to a user.

useSubjectUserboolean
optional

If true, the step will use the subject user of the automation as the subject.

removeFromDelegationobject
optional

RemoveFromDelegation: find all users that have the target user as their delegated user, and modify the delegation.

This message contains a oneof named replacement_user. Only a single field of the following list may be set at a time:

  • replacementUserIdCel
  • replacementUserRef
Hide ParametersShow Parameters
replacementUserIdCelstring
optional

The user who will replace the target user's delegation This field is part of the replacement_user oneof. See the documentation for c1.api.automations.v1.RemoveFromDelegation for more details.

replacementUserRefidstringUserRef
optional

A reference to a user.

userIdCelstring
optional

The userIdCel field.

userRefidstringUserRef
optional

A reference to a user.

useSubjectUserboolean
optional

If true, the step will use the subject user of the automation as the subject.

runAutomationobject
optional

RunAutomation: kick off the execution of an automation template.

This message contains a oneof named automation_template. Only a single field of the following list may be set at a time:

  • automationTemplateRef
  • automationTemplateIdCel
Hide ParametersShow Parameters
automationTemplateIdCelstring
optional

The automationTemplateIdCel field. This field is part of the automation_template oneof. See the documentation for c1.api.automations.v1.RunAutomation for more details.

automationTemplateRefidstringAutomationTemplateRef
optional

The AutomationTemplateRef message.

contextcontextmapAutomationContext
optional

The AutomationContext message.

sendEmailobject
optional

The SendEmail message.

Hide ParametersShow Parameters
bodystring
optional

The body field.

subjectstring
optional

The subject field.

titlestring
optional

The title field.

userIdsCelstring
optional

The userIdsCel field.

userRefsarray of idstringUserRef
optional

The userRefs field.

useSubjectUserboolean
optional

If true, the step will use the subject user of the automation as the subject.

skipIfTrueCelstring
optional

The skipIfTrueCel field.

stepDisplayNamestring
optional

The stepDisplayName field.

stepNamestring
optional

The stepName field.

taskActionobject
optional

The TaskAction message.

This message contains a oneof named action. Only a single field of the following list may be set at a time:

  • close
  • reassign
Hide ParametersShow Parameters
closeobject
optional

The CloseAction message.

This message contains a oneof named user_identifier. Only a single field of the following list may be set at a time:

  • userIdCel
  • userRef
Hide ParametersShow Parameters
userIdCelstring
optional

The userIdCel field. This field is part of the user_identifier oneof. See the documentation for c1.api.automations.v1.CloseAction for more details.

userRefidstringUserRef
optional

A reference to a user.

useSubjectUserboolean
optional

If true, the step will use the subject user of the automation as the subject.

reassignobject
optional

The ReassignAction message.

This message contains a oneof named assignee_user_identifier. Only a single field of the following list may be set at a time:

  • assigneeUserIdCel
  • assigneeUserRef

This message contains a oneof named subject_user_identifier. Only a single field of the following list may be set at a time:

  • subjectUserIdCel
  • subjectUserRef
Hide ParametersShow Parameters
assigneeUserIdCelstring
optional

The assigneeUserIdCel field. This field is part of the assignee_user_identifier oneof. See the documentation for c1.api.automations.v1.ReassignAction for more details.

assigneeUserRefidstringUserRef
optional

A reference to a user.

subjectUserIdCelstring
optional

The subjectUserIdCel field. This field is part of the subject_user_identifier oneof. See the documentation for c1.api.automations.v1.ReassignAction for more details.

subjectUserRefidstringUserRef
optional

A reference to a user.

useSubjectUserboolean
optional

If true, the step will use the subject user of the automation as the subject.

taskTypesarray of enum
optional

The taskTypes field.

Hide ParametersShow Parameters
"TASK_TYPE_UNSPECIFIED"
"TASK_TYPE_REQUEST"
"TASK_TYPE_REVOKE"
"TASK_TYPE_REVIEW"
unenrollFromAllAccessProfilesobject
optional

The UnenrollFromAllAccessProfiles message.

Hide ParametersShow Parameters
catalogIdsarray of string
optional

Optional list of catalog IDs to unenroll from. If empty, unenroll from all catalogs.

catalogIdsCelstring
optional

CEL expression to dynamically select catalog IDs. If provided, overrides catalog_ids.

userIdsCelstring
optional

The userIdsCel field.

userRefsarray of idstringUserRef
optional

The userRefs field.

useSubjectUserboolean
optional

If true, the step will use the subject user of the automation as the subject.

updateUserobject
optional

The UpdateUser message.

This message contains a oneof named user. Only a single field of the following list may be set at a time:

  • userIdCel
  • userRef

This message contains a oneof named user_status. Only a single field of the following list may be set at a time:

  • userStatusEnum
  • userStatusCel
Hide ParametersShow Parameters
userIdCelstring
optional

The userIdCel field. This field is part of the user oneof. See the documentation for c1.api.automations.v1.UpdateUser for more details.

userRefidstringUserRef
optional

A reference to a user.

userStatusCelstring
optional

The userStatusCel field. This field is part of the user_status oneof. See the documentation for c1.api.automations.v1.UpdateUser for more details.

userStatusEnumenum
optional
"UNKNOWN" OR "ENABLED" OR "DISABLED" OR "DELETED"

The userStatusEnum field. This field is part of the user_status oneof. See the documentation for c1.api.automations.v1.UpdateUser for more details.

Hide ParametersShow Parameters
"UNKNOWN"
"ENABLED"
"DISABLED"
"DELETED"
useSubjectUserboolean
optional

If true, the step will use the subject user of the automation as the subject.

waitForDurationobject
optional

The WaitForDuration message.

Hide ParametersShow Parameters
durationstring
optional
formatduration
webhookobject
optional

The Webhook message.

This message contains a oneof named webhook_identifier. Only a single field of the following list may be set at a time:

  • webhookId
  • webhookIdCel
Hide ParametersShow Parameters
payloadmap
optional
webhookIdstring
optional

The webhookId field. This field is part of the webhook_identifier oneof. See the documentation for c1.api.automations.v1.Webhook for more details.

webhookIdCelstring
optional

The webhookIdCel field. This field is part of the webhook_identifier oneof. See the documentation for c1.api.automations.v1.Webhook for more details.

Automation Template Ref
AutomationTemplateRefobject

The AutomationTemplateRef message.

ShowShow
idstring
optional

The id field.

Automation Trigger
AutomationTriggerobject

Automation Triggers

This message contains a oneof named kind. Only a single field of the following list may be set at a time:

  • manual
  • userProfileChange
  • appUserCreated
  • appUserUpdated
  • usageBasedRevocation
ShowShow
appUserCreatedobject
optional

The AppUserCreatedTrigger message.

This message contains a oneof named app_identifier. Only a single field of the following list may be set at a time:

  • appId
  • appIdCel
Hide ParametersShow Parameters
appIdstring
optional

The appId field. This field is part of the app_identifier oneof. See the documentation for c1.api.automations.v1.AppUserCreatedTrigger for more details.

appIdCelstring
optional

The appIdCel field. This field is part of the app_identifier oneof. See the documentation for c1.api.automations.v1.AppUserCreatedTrigger for more details.

appUserUpdatedobject
optional

The AppUserUpdatedTrigger message.

This message contains a oneof named app_identifier. Only a single field of the following list may be set at a time:

  • appId
  • appIdCel
Hide ParametersShow Parameters
appIdstring
optional

The appId field. This field is part of the app_identifier oneof. See the documentation for c1.api.automations.v1.AppUserUpdatedTrigger for more details.

appIdCelstring
optional

The appIdCel field. This field is part of the app_identifier oneof. See the documentation for c1.api.automations.v1.AppUserUpdatedTrigger for more details.

conditionstring
optional

The condition field.

manualunknown
optional

The ManualAutomationTrigger message.

usageBasedRevocationobject
optional

The UsageBasedRevocationTrigger message.

This message contains a oneof named cold_start_schedule. Only a single field of the following list may be set at a time:

  • runImmediately
  • runDelayed
Hide ParametersShow Parameters
appIdstring
optional

The appId field.

enabledAtstring
optional
formatdate-time
excludedGroupRefsarray of idstringappIdstringAppEntitlementRef
optional

The excludedGroupRefs field.

excludedUserRefsarray of idstringUserRef
optional

The excludedUserRefs field.

includeUsersWithNoActivityboolean
optional

The includeUsersWithNoActivity field.

runDelayedobject
optional

The RunDelayed message.

Hide ParametersShow Parameters
coldStartDelayDaysnumber

The coldStartDelayDays field.

formatuint32
runImmediatelyunknown
optional

No fields needed; this just indicates the trigger should run immediately

targetedAppUserTypesarray of enum
optional

The targetedAppUserTypes field.

Hide ParametersShow Parameters
"APP_USER_TYPE_UNSPECIFIED"
"APP_USER_TYPE_USER"
"APP_USER_TYPE_SERVICE_ACCOUNT"
"APP_USER_TYPE_SYSTEM_ACCOUNT"
targetedEntitlementRefsarray of idstringappIdstringAppEntitlementRef
optional

The targetedEntitlementRefs field.

unusedForDaysnumber
optional

The unusedForDays field.

formatuint32
userProfileChangeobject
optional

The UserProfileChangeTrigger message.

Hide ParametersShow Parameters
profileAttributeCelstring
optional

The profileAttributeCel field.

profileAttributeKeystring
optional

The profileAttributeKey field.

Connector Ref
ConnectorRefobject

The ConnectorRef message.

ShowShow
idstring
optional

The id field.

appIdstring
optional

The appId field.