Skip to content
  • Auto
  • Light
  • Dark
Get Started

Create

Create Automation
client.Automations.New(ctx, body) (*AutomationAutomationAutomationNewResponse, error)
post/api/v1/automations

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

Parameters
bodyAppIDfieldAutomationStepsfieldContextfieldDescriptionfieldDisplayNamefieldDraftAutomationStepsfieldDraftTriggersfieldEnabledfieldIsDraftfieldTriggersfieldAutomationNewParams
Hide ParametersShow Parameters
AppIDfield
optional
param.Field[string]

the app id this workflow_template belongs to

AutomationStepsfield
optional
param.Field[[]ConnectorActionAutomationStepConnectorActionConnectorCreateAccountAutomationStepConnectorCreateAccountCreateAccessReviewAutomationStepCreateAccessReviewCreateRevokeTasksAutomationStepCreateRevokeTasksRemoveFromDelegationAutomationStepRemoveFromDelegationRunAutomationAutomationStepRunAutomationSendEmailAutomationStepSendEmailSkipIfTrueCelstringStepDisplayNamestringStepNamestringTaskActionAutomationStepTaskActionUnenrollFromAllAccessProfilesAutomationStepUnenrollFromAllAccessProfilesUpdateUserAutomationStepUpdateUserWaitForDurationAutomationStepWaitForDurationWebhookAutomationStepWebhookAutomationStep]

The automationSteps field.

Hide ParametersShow Parameters
ConnectorActionActionNamestringArgsTemplatemapConnectorRefConnectorRefAutomationStepConnectorAction
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
map[string, any]
ConnectorRefIDstringAppIDstringConnectorRef
optional

The ConnectorRef message.

ConnectorCreateAccountConnectorRefConnectorRefUserIDCelstringUserPropertiesAutomationStepConnectorCreateAccountUserPropertiesAutomationStepConnectorCreateAccount
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.

UserPropertiesDisplayNameCelstringEmailCelstringProfileAttributeCelstringUsernameCelstringAutomationStepConnectorCreateAccountUserProperties
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.

CreateAccessReviewAccessReviewTemplateCelstringAccessReviewTemplateIDstringUserIDsCelstringUserRefsarrayUseSubjectUserboolAutomationStepCreateAccessReview
optional

The CreateAccessReview message.

Hide ParametersShow Parameters
AccessReviewTemplateCelstring
optional

The accessReviewTemplateCel field.

AccessReviewTemplateIDstring
optional

The accessReviewTemplateId field.

UserIDsCelstring
optional

The userIdsCel field.

UserRefsarray
optional
[]IDstringUserRef

The userRefs field.

Hide ParametersShow Parameters
IDstring
optional

The id of the user.

UseSubjectUserbool
optional

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

CreateRevokeTasksAppEntitlementRefsarrayAppEntitlementRefsCelstringRevokeAllboolUserIDCelstringUserRefUserRefUseSubjectUserboolAutomationStepCreateRevokeTasks
optional

The CreateRevokeTasks message.

Hide ParametersShow Parameters
AppEntitlementRefsarray
optional
[]IDstringAppIDstringAppEntitlementRef

The appEntitlementRefs field.

Hide ParametersShow Parameters
IDstring
optional

The id field.

AppIDstring
optional

The appId field.

AppEntitlementRefsCelstring
optional

The appEntitlementRefsCel field.

RevokeAllbool
optional

The revokeAll field.

UserIDCelstring
optional

The userIdCel field.

UserRefIDstringUserRef
optional

A reference to a user.

UseSubjectUserbool
optional

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

RemoveFromDelegationReplacementUserIDCelstringReplacementUserRefUserRefUserIDCelstringUserRefUserRefUseSubjectUserboolAutomationStepRemoveFromDelegation
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.

UseSubjectUserbool
optional

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

RunAutomationAutomationTemplateIDCelstringAutomationTemplateRefAutomationTemplateRefContextAutomationContextAutomationStepRunAutomation
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.

SendEmailBodystringSubjectstringTitlestringUserIDsCelstringUserRefsarrayUseSubjectUserboolAutomationStepSendEmail
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
optional
[]IDstringUserRef

The userRefs field.

Hide ParametersShow Parameters
IDstring
optional

The id of the user.

UseSubjectUserbool
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.

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
CloseUserIDCelstringUserRefUserRefUseSubjectUserboolAutomationStepTaskActionClose
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.

UseSubjectUserbool
optional

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

ReassignAssigneeUserIDCelstringAssigneeUserRefUserRefSubjectUserIDCelstringSubjectUserRefUserRefUseSubjectUserboolAutomationStepTaskActionReassign
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.

UseSubjectUserbool
optional

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

TaskTypesarray
optional
[]string

The taskTypes field.

Hide ParametersShow Parameters
AutomationStepTaskActionTaskTypeTaskTypeUnspecifiedconst
"TASK_TYPE_UNSPECIFIED"
AutomationStepTaskActionTaskTypeTaskTypeRequestconst
"TASK_TYPE_REQUEST"
AutomationStepTaskActionTaskTypeTaskTypeRevokeconst
"TASK_TYPE_REVOKE"
AutomationStepTaskActionTaskTypeTaskTypeReviewconst
"TASK_TYPE_REVIEW"
UnenrollFromAllAccessProfilesCatalogIDsarrayCatalogIDsCelstringUserIDsCelstringUserRefsarrayUseSubjectUserboolAutomationStepUnenrollFromAllAccessProfiles
optional

The UnenrollFromAllAccessProfiles message.

Hide ParametersShow Parameters
CatalogIDsarray
optional
[]string

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
optional
[]IDstringUserRef

The userRefs field.

Hide ParametersShow Parameters
IDstring
optional

The id of the user.

UseSubjectUserbool
optional

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

UpdateUserUserIDCelstringUserRefUserRefUserStatusCelstringUserStatusEnumstringUseSubjectUserboolAutomationStepUpdateUser
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.

UserStatusEnumstring
optional

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
AutomationStepUpdateUserUserStatusEnumUnknownconst
AutomationStepUpdateUserUserStatusEnumUnknownAutomationStepUpdateUserUserStatusEnumAutomationStepUpdateUserUserStatusEnumEnabledAutomationStepUpdateUserUserStatusEnumAutomationStepUpdateUserUserStatusEnumDisabledAutomationStepUpdateUserUserStatusEnumAutomationStepUpdateUserUserStatusEnumDeletedAutomationStepUpdateUserUserStatusEnumAutomationStepUpdateUserUserStatusEnum
"UNKNOWN"
AutomationStepUpdateUserUserStatusEnumEnabledconst
AutomationStepUpdateUserUserStatusEnumUnknownAutomationStepUpdateUserUserStatusEnumAutomationStepUpdateUserUserStatusEnumEnabledAutomationStepUpdateUserUserStatusEnumAutomationStepUpdateUserUserStatusEnumDisabledAutomationStepUpdateUserUserStatusEnumAutomationStepUpdateUserUserStatusEnumDeletedAutomationStepUpdateUserUserStatusEnumAutomationStepUpdateUserUserStatusEnum
"ENABLED"
AutomationStepUpdateUserUserStatusEnumDisabledconst
AutomationStepUpdateUserUserStatusEnumUnknownAutomationStepUpdateUserUserStatusEnumAutomationStepUpdateUserUserStatusEnumEnabledAutomationStepUpdateUserUserStatusEnumAutomationStepUpdateUserUserStatusEnumDisabledAutomationStepUpdateUserUserStatusEnumAutomationStepUpdateUserUserStatusEnumDeletedAutomationStepUpdateUserUserStatusEnumAutomationStepUpdateUserUserStatusEnum
"DISABLED"
AutomationStepUpdateUserUserStatusEnumDeletedconst
AutomationStepUpdateUserUserStatusEnumUnknownAutomationStepUpdateUserUserStatusEnumAutomationStepUpdateUserUserStatusEnumEnabledAutomationStepUpdateUserUserStatusEnumAutomationStepUpdateUserUserStatusEnumDisabledAutomationStepUpdateUserUserStatusEnumAutomationStepUpdateUserUserStatusEnumDeletedAutomationStepUpdateUserUserStatusEnumAutomationStepUpdateUserUserStatusEnum
"DELETED"
UseSubjectUserbool
optional

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

WaitForDurationDurationstringAutomationStepWaitForDuration
optional

The WaitForDuration message.

Hide ParametersShow Parameters
Durationstring
optional
formatduration
WebhookPayloadmapWebhookIDstringWebhookIDCelstringAutomationStepWebhook
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
map[string, any]
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.

Contextfield
optional
param.Field[ContextmapAutomationContext]

The AutomationContext message.

Descriptionfield
optional
param.Field[string]

The description field.

DisplayNamefield
optional
param.Field[string]

The displayName field.

DraftAutomationStepsfield
optional
param.Field[[]ConnectorActionAutomationStepConnectorActionConnectorCreateAccountAutomationStepConnectorCreateAccountCreateAccessReviewAutomationStepCreateAccessReviewCreateRevokeTasksAutomationStepCreateRevokeTasksRemoveFromDelegationAutomationStepRemoveFromDelegationRunAutomationAutomationStepRunAutomationSendEmailAutomationStepSendEmailSkipIfTrueCelstringStepDisplayNamestringStepNamestringTaskActionAutomationStepTaskActionUnenrollFromAllAccessProfilesAutomationStepUnenrollFromAllAccessProfilesUpdateUserAutomationStepUpdateUserWaitForDurationAutomationStepWaitForDurationWebhookAutomationStepWebhookAutomationStep]

The draftAutomationSteps field.

Hide ParametersShow Parameters
ConnectorActionActionNamestringArgsTemplatemapConnectorRefConnectorRefAutomationStepConnectorAction
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
map[string, any]
ConnectorRefIDstringAppIDstringConnectorRef
optional

The ConnectorRef message.

ConnectorCreateAccountConnectorRefConnectorRefUserIDCelstringUserPropertiesAutomationStepConnectorCreateAccountUserPropertiesAutomationStepConnectorCreateAccount
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.

UserPropertiesDisplayNameCelstringEmailCelstringProfileAttributeCelstringUsernameCelstringAutomationStepConnectorCreateAccountUserProperties
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.

CreateAccessReviewAccessReviewTemplateCelstringAccessReviewTemplateIDstringUserIDsCelstringUserRefsarrayUseSubjectUserboolAutomationStepCreateAccessReview
optional

The CreateAccessReview message.

Hide ParametersShow Parameters
AccessReviewTemplateCelstring
optional

The accessReviewTemplateCel field.

AccessReviewTemplateIDstring
optional

The accessReviewTemplateId field.

UserIDsCelstring
optional

The userIdsCel field.

UserRefsarray
optional
[]IDstringUserRef

The userRefs field.

Hide ParametersShow Parameters
IDstring
optional

The id of the user.

UseSubjectUserbool
optional

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

CreateRevokeTasksAppEntitlementRefsarrayAppEntitlementRefsCelstringRevokeAllboolUserIDCelstringUserRefUserRefUseSubjectUserboolAutomationStepCreateRevokeTasks
optional

The CreateRevokeTasks message.

Hide ParametersShow Parameters
AppEntitlementRefsarray
optional
[]IDstringAppIDstringAppEntitlementRef

The appEntitlementRefs field.

Hide ParametersShow Parameters
IDstring
optional

The id field.

AppIDstring
optional

The appId field.

AppEntitlementRefsCelstring
optional

The appEntitlementRefsCel field.

RevokeAllbool
optional

The revokeAll field.

UserIDCelstring
optional

The userIdCel field.

UserRefIDstringUserRef
optional

A reference to a user.

UseSubjectUserbool
optional

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

RemoveFromDelegationReplacementUserIDCelstringReplacementUserRefUserRefUserIDCelstringUserRefUserRefUseSubjectUserboolAutomationStepRemoveFromDelegation
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.

UseSubjectUserbool
optional

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

RunAutomationAutomationTemplateIDCelstringAutomationTemplateRefAutomationTemplateRefContextAutomationContextAutomationStepRunAutomation
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.

SendEmailBodystringSubjectstringTitlestringUserIDsCelstringUserRefsarrayUseSubjectUserboolAutomationStepSendEmail
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
optional
[]IDstringUserRef

The userRefs field.

Hide ParametersShow Parameters
IDstring
optional

The id of the user.

UseSubjectUserbool
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.

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
CloseUserIDCelstringUserRefUserRefUseSubjectUserboolAutomationStepTaskActionClose
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.

UseSubjectUserbool
optional

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

ReassignAssigneeUserIDCelstringAssigneeUserRefUserRefSubjectUserIDCelstringSubjectUserRefUserRefUseSubjectUserboolAutomationStepTaskActionReassign
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.

UseSubjectUserbool
optional

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

TaskTypesarray
optional
[]string

The taskTypes field.

Hide ParametersShow Parameters
AutomationStepTaskActionTaskTypeTaskTypeUnspecifiedconst
"TASK_TYPE_UNSPECIFIED"
AutomationStepTaskActionTaskTypeTaskTypeRequestconst
"TASK_TYPE_REQUEST"
AutomationStepTaskActionTaskTypeTaskTypeRevokeconst
"TASK_TYPE_REVOKE"
AutomationStepTaskActionTaskTypeTaskTypeReviewconst
"TASK_TYPE_REVIEW"
UnenrollFromAllAccessProfilesCatalogIDsarrayCatalogIDsCelstringUserIDsCelstringUserRefsarrayUseSubjectUserboolAutomationStepUnenrollFromAllAccessProfiles
optional

The UnenrollFromAllAccessProfiles message.

Hide ParametersShow Parameters
CatalogIDsarray
optional
[]string

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
optional
[]IDstringUserRef

The userRefs field.

Hide ParametersShow Parameters
IDstring
optional

The id of the user.

UseSubjectUserbool
optional

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

UpdateUserUserIDCelstringUserRefUserRefUserStatusCelstringUserStatusEnumstringUseSubjectUserboolAutomationStepUpdateUser
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.

UserStatusEnumstring
optional

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
AutomationStepUpdateUserUserStatusEnumUnknownconst
AutomationStepUpdateUserUserStatusEnumUnknownAutomationStepUpdateUserUserStatusEnumAutomationStepUpdateUserUserStatusEnumEnabledAutomationStepUpdateUserUserStatusEnumAutomationStepUpdateUserUserStatusEnumDisabledAutomationStepUpdateUserUserStatusEnumAutomationStepUpdateUserUserStatusEnumDeletedAutomationStepUpdateUserUserStatusEnumAutomationStepUpdateUserUserStatusEnum
"UNKNOWN"
AutomationStepUpdateUserUserStatusEnumEnabledconst
AutomationStepUpdateUserUserStatusEnumUnknownAutomationStepUpdateUserUserStatusEnumAutomationStepUpdateUserUserStatusEnumEnabledAutomationStepUpdateUserUserStatusEnumAutomationStepUpdateUserUserStatusEnumDisabledAutomationStepUpdateUserUserStatusEnumAutomationStepUpdateUserUserStatusEnumDeletedAutomationStepUpdateUserUserStatusEnumAutomationStepUpdateUserUserStatusEnum
"ENABLED"
AutomationStepUpdateUserUserStatusEnumDisabledconst
AutomationStepUpdateUserUserStatusEnumUnknownAutomationStepUpdateUserUserStatusEnumAutomationStepUpdateUserUserStatusEnumEnabledAutomationStepUpdateUserUserStatusEnumAutomationStepUpdateUserUserStatusEnumDisabledAutomationStepUpdateUserUserStatusEnumAutomationStepUpdateUserUserStatusEnumDeletedAutomationStepUpdateUserUserStatusEnumAutomationStepUpdateUserUserStatusEnum
"DISABLED"
AutomationStepUpdateUserUserStatusEnumDeletedconst
AutomationStepUpdateUserUserStatusEnumUnknownAutomationStepUpdateUserUserStatusEnumAutomationStepUpdateUserUserStatusEnumEnabledAutomationStepUpdateUserUserStatusEnumAutomationStepUpdateUserUserStatusEnumDisabledAutomationStepUpdateUserUserStatusEnumAutomationStepUpdateUserUserStatusEnumDeletedAutomationStepUpdateUserUserStatusEnumAutomationStepUpdateUserUserStatusEnum
"DELETED"
UseSubjectUserbool
optional

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

WaitForDurationDurationstringAutomationStepWaitForDuration
optional

The WaitForDuration message.

Hide ParametersShow Parameters
Durationstring
optional
formatduration
WebhookPayloadmapWebhookIDstringWebhookIDCelstringAutomationStepWebhook
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
map[string, any]
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.

DraftTriggersfield
optional

The draftTriggers field.

Hide ParametersShow Parameters
AppUserCreatedAppIDstringAppIDCelstringAutomationTriggerAppUserCreated
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.

AppUserUpdatedAppIDstringAppIDCelstringAutomationTriggerAppUserUpdated
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.

Manualany
optional

The ManualAutomationTrigger message.

UsageBasedRevocationAppIDstringEnabledAtTimeExcludedGroupRefsarrayExcludedUserRefsarrayIncludeUsersWithNoActivityboolRunDelayedAutomationTriggerUsageBasedRevocationRunDelayedRunImmediatelyanyTargetedAppUserTypesarrayTargetedEntitlementRefsarrayUnusedForDaysint64AutomationTriggerUsageBasedRevocation
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.

EnabledAtTime
optional
formatdate-time
ExcludedGroupRefsarray
optional
[]IDstringAppIDstringAppEntitlementRef

The excludedGroupRefs field.

Hide ParametersShow Parameters
IDstring
optional

The id field.

AppIDstring
optional

The appId field.

ExcludedUserRefsarray
optional
[]IDstringUserRef

The excludedUserRefs field.

Hide ParametersShow Parameters
IDstring
optional

The id of the user.

IncludeUsersWithNoActivitybool
optional

The includeUsersWithNoActivity field.

RunDelayedColdStartDelayDaysint64AutomationTriggerUsageBasedRevocationRunDelayed
optional

The RunDelayed message.

Hide ParametersShow Parameters
ColdStartDelayDaysint64

The coldStartDelayDays field.

formatuint32
RunImmediatelyany
optional

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

TargetedAppUserTypesarray
optional
[]string

The targetedAppUserTypes field.

Hide ParametersShow Parameters
AutomationTriggerUsageBasedRevocationTargetedAppUserTypeAppUserTypeUnspecifiedconst
"APP_USER_TYPE_UNSPECIFIED"
AutomationTriggerUsageBasedRevocationTargetedAppUserTypeAppUserTypeUserconst
"APP_USER_TYPE_USER"
AutomationTriggerUsageBasedRevocationTargetedAppUserTypeAppUserTypeServiceAccountconst
"APP_USER_TYPE_SERVICE_ACCOUNT"
AutomationTriggerUsageBasedRevocationTargetedAppUserTypeAppUserTypeSystemAccountconst
"APP_USER_TYPE_SYSTEM_ACCOUNT"
TargetedEntitlementRefsarray
optional
[]IDstringAppIDstringAppEntitlementRef

The targetedEntitlementRefs field.

Hide ParametersShow Parameters
IDstring
optional

The id field.

AppIDstring
optional

The appId field.

UnusedForDaysint64
optional

The unusedForDays field.

formatuint32
UserProfileChangeProfileAttributeCelstringProfileAttributeKeystringAutomationTriggerUserProfileChange
optional

The UserProfileChangeTrigger message.

Hide ParametersShow Parameters
ProfileAttributeCelstring
optional

The profileAttributeCel field.

ProfileAttributeKeystring
optional

The profileAttributeKey field.

Enabledfield
optional
param.Field[bool]

The enabled field.

IsDraftfield
optional
param.Field[bool]

The isDraft field.

Triggersfield
optional

The triggers field.

Hide ParametersShow Parameters
AppUserCreatedAppIDstringAppIDCelstringAutomationTriggerAppUserCreated
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.

AppUserUpdatedAppIDstringAppIDCelstringAutomationTriggerAppUserUpdated
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.

Manualany
optional

The ManualAutomationTrigger message.

UsageBasedRevocationAppIDstringEnabledAtTimeExcludedGroupRefsarrayExcludedUserRefsarrayIncludeUsersWithNoActivityboolRunDelayedAutomationTriggerUsageBasedRevocationRunDelayedRunImmediatelyanyTargetedAppUserTypesarrayTargetedEntitlementRefsarrayUnusedForDaysint64AutomationTriggerUsageBasedRevocation
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.

EnabledAtTime
optional
formatdate-time
ExcludedGroupRefsarray
optional
[]IDstringAppIDstringAppEntitlementRef

The excludedGroupRefs field.

Hide ParametersShow Parameters
IDstring
optional

The id field.

AppIDstring
optional

The appId field.

ExcludedUserRefsarray
optional
[]IDstringUserRef

The excludedUserRefs field.

Hide ParametersShow Parameters
IDstring
optional

The id of the user.

IncludeUsersWithNoActivitybool
optional

The includeUsersWithNoActivity field.

RunDelayedColdStartDelayDaysint64AutomationTriggerUsageBasedRevocationRunDelayed
optional

The RunDelayed message.

Hide ParametersShow Parameters
ColdStartDelayDaysint64

The coldStartDelayDays field.

formatuint32
RunImmediatelyany
optional

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

TargetedAppUserTypesarray
optional
[]string

The targetedAppUserTypes field.

Hide ParametersShow Parameters
AutomationTriggerUsageBasedRevocationTargetedAppUserTypeAppUserTypeUnspecifiedconst
"APP_USER_TYPE_UNSPECIFIED"
AutomationTriggerUsageBasedRevocationTargetedAppUserTypeAppUserTypeUserconst
"APP_USER_TYPE_USER"
AutomationTriggerUsageBasedRevocationTargetedAppUserTypeAppUserTypeServiceAccountconst
"APP_USER_TYPE_SERVICE_ACCOUNT"
AutomationTriggerUsageBasedRevocationTargetedAppUserTypeAppUserTypeSystemAccountconst
"APP_USER_TYPE_SYSTEM_ACCOUNT"
TargetedEntitlementRefsarray
optional
[]IDstringAppIDstringAppEntitlementRef

The targetedEntitlementRefs field.

Hide ParametersShow Parameters
IDstring
optional

The id field.

AppIDstring
optional

The appId field.

UnusedForDaysint64
optional

The unusedForDays field.

formatuint32
UserProfileChangeProfileAttributeCelstringProfileAttributeKeystringAutomationTriggerUserProfileChange
optional

The UserProfileChangeTrigger message.

Hide ParametersShow Parameters
ProfileAttributeCelstring
optional

The profileAttributeCel field.

ProfileAttributeKeystring
optional

The profileAttributeKey field.

Returns
AutomationNewResponsestruct

The CreateAutomationResponse message.

Hide ParametersShow Parameters
AutomationIDstringAppIDstringAutomationStepsarrayContextAutomationContextCreatedAtTimeCurrentVersionstringDescriptionstringDisplayNamestringDraftAutomationStepsarrayDraftTriggersarrayEnabledboolIsDraftboolLastExecutedAtTimeTriggersarrayAutomation
optional

The Automation message.

Request example Go
package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := conductoronesdk.NewClient(
    option.WithAPIKey("My API Key"),
  )
  automation, err := client.Automations.New(context.TODO(), conductoronesdk.AutomationNewParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", automation.Automation)
}
200 Example
{
  "automation": {
    "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"
        }
      }
    ]
  }
}