LukeParke/api-specs
1
0
Fork 0
mirror of https://github.com/LukeHagar/api-specs.git synced 2025-12-09 04:19:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #25 from sailpoint-oss/nerocket-73-api-docs

Browse Source 
NEROCKET-73 Cypress PreReq - Create Request Form Workflow Action via API
This commit is contained in:
Kaitlin Torre
2023-08-24 08:56:29 -04:00
committed by GitHub
parent 64b484fe5e 586d1573be
commit 4fdbd61f08
87 changed files with 1689 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
nerm/openapi.yaml
View File

@@ -118,6 +118,63 @@ paths:
$ref: "./paths/workflows/login_workflow.yaml"
/workflows/password_reset_workflows:
$ref: "./paths/workflows/password_reset_workflow.yaml"
# Workflow Actions
/workflow_actions/approval_actions:
$ref: "./paths/workflow_actions/approval_action.yaml"
/workflow_actions/ask_security_question_actions:
$ref: "./paths/workflow_actions/ask_security_question_action.yaml"
/workflow_actions/auto_assign_actions:
$ref: "./paths/workflow_actions/auto_assign_action.yaml"
/workflow_actions/batch_update_actions:
$ref: "./paths/workflow_actions/batch_update_action.yaml"
/workflow_actions/close_session_actions:
$ref: "./paths/workflow_actions/close_session_action.yaml"
/workflow_actions/contributors_actions:
$ref: "./paths/workflow_actions/contributors_action.yaml"
/workflow_actions/create_profile_actions:
$ref: "./paths/workflow_actions/create_profile_action.yaml"
/workflow_actions/duplicate_prevention_actions:
$ref: "./paths/workflow_actions/duplicate_prevention_action.yaml"
/workflow_actions/email_verification_actions:
$ref: "./paths/workflow_actions/email_verification_action.yaml"
/workflow_actions/fulfillment_actions:
$ref: "./paths/workflow_actions/fulfillment_action.yaml"
/workflow_actions/identity_proofing_actions:
$ref: "./paths/workflow_actions/identity_proofing_action.yaml"
/workflow_actions/invitation_actions:
$ref: "./paths/workflow_actions/invitation_action.yaml"
/workflow_actions/ldap_actions:
$ref: "./paths/workflow_actions/ldap_action.yaml"
/workflow_actions/notification_actions:
$ref: "./paths/workflow_actions/notification_action.yaml"
/workflow_actions/password_reset_actions:
$ref: "./paths/workflow_actions/password_reset_action.yaml"
/workflow_actions/profile_check_actions:
$ref: "./paths/workflow_actions/profile_check_action.yaml"
/workflow_actions/profile_select_actions:
$ref: "./paths/workflow_actions/profile_select_action.yaml"
/workflow_actions/request_actions:
$ref: "./paths/workflow_actions/request_action.yaml"
/workflow_actions/rest_api_actions:
$ref: "./paths/workflow_actions/rest_api_action.yaml"
/workflow_actions/review_actions:
$ref: "./paths/workflow_actions/review_action.yaml"
/workflow_actions/run_workflow_actions:
$ref: "./paths/workflow_actions/run_workflow_action.yaml"
/workflow_actions/set_attributes_actions:
$ref: "./paths/workflow_actions/set_attributes_action.yaml"
/workflow_actions/set_security_question_actions:
$ref: "./paths/workflow_actions/set_security_question_action.yaml"
/workflow_actions/soap_api_actions:
$ref: "./paths/workflow_actions/soap_api_action.yaml"
/workflow_actions/status_change_actions:
$ref: "./paths/workflow_actions/status_change_action.yaml"
/workflow_actions/unassign_actions:
$ref: "./paths/workflow_actions/unassign_action.yaml"
/workflow_actions/update_profile_actions:
$ref: "./paths/workflow_actions/update_profile_action.yaml"
/workflow_actions/username_password_actions:
$ref: "./paths/workflow_actions/username_password_action.yaml"
# Workflow Sessions
/workflow_sessions:
$ref: "./paths/workflow_sessions.yaml"

15
nerm/paths/workflow_actions/approval_action.yaml Normal file
View File

@@ -0,0 +1,15 @@
post:
summary: Create an approval action
operationId: createApprovalAction
description: Create an approval action. Coordinate with workflow_action_performers to set up performers. Coordinate with workflow_action_roles to set up performers by role. Coordinate with workflow_action_performer_notification_email for performer email config. Coordinate with workflow_action_approval_email for approval email config. Coordinate with workflow_action_rejection_email for rejection email config.
tags:
- workflow actions
requestBody:
$ref: "../../requestBodies/POST/WorkflowActions/ApprovalAction.yaml"
responses:
'200':
$ref: "../../responses/WorkflowAction.yaml"
'400':
$ref: "../../responses/400.yaml"
'500':
$ref: "../../responses/500.yaml"

15
nerm/paths/workflow_actions/ask_security_question_action.yaml Normal file
View File

@@ -0,0 +1,15 @@
post:
summary: Create ask security question action
operationId: createAskSecurityQuestionAction
description: Create an ask security question action
tags:
- workflow actions
requestBody:
$ref: "../../requestBodies/POST/WorkflowActions/AskSecurityQuestionAction.yaml"
responses:
'200':
$ref: "../../responses/WorkflowAction.yaml"
'400':
$ref: "../../responses/400.yaml"
'500':
$ref: "../../responses/500.yaml"

15
nerm/paths/workflow_actions/auto_assign_action.yaml Normal file
View File

@@ -0,0 +1,15 @@
post:
summary: Create an auto assign action
operationId: createAutoAssignAction
description: Create an auto assign action. Coordinate with workflow_action_roles to assign roles.
tags:
- workflow actions
requestBody:
$ref: "../../requestBodies/POST/WorkflowActions/AutoAssignAction.yaml"
responses:
'200':
$ref: "../../responses/WorkflowAction.yaml"
'400':
$ref: "../../responses/400.yaml"
'500':
$ref: "../../responses/500.yaml"

15
nerm/paths/workflow_actions/batch_update_action.yaml Normal file
View File

@@ -0,0 +1,15 @@
post:
summary: Create a batch update action
operationId: createBatchUpdateAction
description: Create a batch update action
tags:
- workflow actions
requestBody:
$ref: "../../requestBodies/POST/WorkflowActions/BatchUpdateAction.yaml"
responses:
'200':
$ref: "../../responses/WorkflowAction.yaml"
'400':
$ref: "../../responses/400.yaml"
'500':
$ref: "../../responses/500.yaml"

15
nerm/paths/workflow_actions/close_session_action.yaml Normal file
View File

@@ -0,0 +1,15 @@
post:
summary: Create a close session action
operationId: createCloseSessionAction
description: Create a close session action
tags:
- workflow actions
requestBody:
$ref: "../../requestBodies/POST/WorkflowActions/CloseSessionAction.yaml"
responses:
'200':
$ref: "../../responses/WorkflowAction.yaml"
'400':
$ref: "../../responses/400.yaml"
'500':
$ref: "../../responses/500.yaml"

15
nerm/paths/workflow_actions/contributors_action.yaml Normal file
View File

@@ -0,0 +1,15 @@
post:
summary: Create a contributors action
operationId: createContributorsAction
description: Create a contributors action. Coordinate with workflow_action_performers to set up performers. Coordinate with workflow_action_roles to set up performers by role. Coordinate with workflow_action_performer_notification_email for performer email config.
tags:
- workflow actions
requestBody:
$ref: "../../requestBodies/POST/WorkflowActions/ContributorsAction.yaml"
responses:
'200':
$ref: "../../responses/WorkflowAction.yaml"
'400':
$ref: "../../responses/400.yaml"
'500':
$ref: "../../responses/500.yaml"

15
nerm/paths/workflow_actions/create_profile_action.yaml Normal file
View File

@@ -0,0 +1,15 @@
post:
summary: Create a create profile action
operationId: createCreateProfileAction
description: Create a create profile action
tags:
- workflow actions
requestBody:
$ref: "../../requestBodies/POST/WorkflowActions/CreateProfileAction.yaml"
responses:
'200':
$ref: "../../responses/WorkflowAction.yaml"
'400':
$ref: "../../responses/400.yaml"
'500':
$ref: "../../responses/500.yaml"

15
nerm/paths/workflow_actions/duplicate_prevention_action.yaml Normal file
View File

@@ -0,0 +1,15 @@
post:
summary: Create a duplicate prevention action
operationId: createDuplicatePreventionAction
description: Create a duplicate prevention action. Coordinate with duplicatation_prevention_attributes to set up duplicate matching. Coordinate with workflow_action_performers to set up performers. Coordinate with workflow_action_roles to set up performers by role. Coordinate with workflow_action_performer_notification_email for performer email config.
tags:
- workflow actions
requestBody:
$ref: "../../requestBodies/POST/WorkflowActions/DuplicatePreventionAction.yaml"
responses:
'200':
$ref: "../../responses/WorkflowAction.yaml"
'400':
$ref: "../../responses/400.yaml"
'500':
$ref: "../../responses/500.yaml"

15
nerm/paths/workflow_actions/email_verification_action.yaml Normal file
View File

@@ -0,0 +1,15 @@
post:
summary: Create an email verification action
operationId: createEmailVerificationAction
description: Create an email verification action
tags:
- workflow actions
requestBody:
$ref: "../../requestBodies/POST/WorkflowActions/EmailVerificationAction.yaml"
responses:
'200':
$ref: "../../responses/WorkflowAction.yaml"
'400':
$ref: "../../responses/400.yaml"
'500':
$ref: "../../responses/500.yaml"

15
nerm/paths/workflow_actions/fulfillment_action.yaml Normal file
View File

@@ -0,0 +1,15 @@
post:
summary: Create a fulfillent action
operationId: createFulfillmentAction
description: Create a fulfillment action. Coordinate with workflow_action_performers to set up performers. Coordinate with workflow_action_roles to set up performers by role. Coordinate with workflow_action_performer_notification_email for performer email config.
tags:
- workflow actions
requestBody:
$ref: "../../requestBodies/POST/WorkflowActions/FulfillmentAction.yaml"
responses:
'200':
$ref: "../../responses/WorkflowAction.yaml"
'400':
$ref: "../../responses/400.yaml"
'500':
$ref: "../../responses/500.yaml"

15
nerm/paths/workflow_actions/identity_proofing_action.yaml Normal file
View File

@@ -0,0 +1,15 @@
post:
summary: Create an identity proofing action
operationId: createIdentityProofingAction
description: Create an identity proofing action. Coordinates with identity_proofing_action_configuration for configuration. Coordinates with identity_proofing_action_mappings for mapping.
tags:
- workflow actions
requestBody:
$ref: "../../requestBodies/POST/WorkflowActions/IdentityProofingAction.yaml"
responses:
'200':
$ref: "../../responses/WorkflowAction.yaml"
'400':
$ref: "../../responses/400.yaml"
'500':
$ref: "../../responses/500.yaml"

15
nerm/paths/workflow_actions/invitation_action.yaml Normal file
View File

@@ -0,0 +1,15 @@
post:
summary: Create an invitation action
operationId: createInvitationAction
description: Create an invitation action. Coordinate with workflow_action_pause_action if action is to wait for completion.
tags:
- workflow actions
requestBody:
$ref: "../../requestBodies/POST/WorkflowActions/InvitationAction.yaml"
responses:
'200':
$ref: "../../responses/WorkflowAction.yaml"
'400':
$ref: "../../responses/400.yaml"
'500':
$ref: "../../responses/500.yaml"

15
nerm/paths/workflow_actions/ldap_action.yaml Normal file
View File

@@ -0,0 +1,15 @@
post:
summary: Create a ldap action
operationId: createLdapAction
description: Create a ldap action. Coordinate with workflow_action_performers to set up performers. Coordinate with workflow_action_roles to set up performers by role.
tags:
- workflow actions
requestBody:
$ref: "../../requestBodies/POST/WorkflowActions/LdapAction.yaml"
responses:
'200':
$ref: "../../responses/WorkflowAction.yaml"
'400':
$ref: "../../responses/400.yaml"
'500':
$ref: "../../responses/500.yaml"

15
nerm/paths/workflow_actions/notification_action.yaml Normal file
View File

@@ -0,0 +1,15 @@
post:
summary: Create a notification action
operationId: createNotificationAction
description: Create a notification action
tags:
- workflow actions
requestBody:
$ref: "../../requestBodies/POST/WorkflowActions/NotificationAction.yaml"
responses:
'200':
$ref: "../../responses/WorkflowAction.yaml"
'400':
$ref: "../../responses/400.yaml"
'500':
$ref: "../../responses/500.yaml"

15
nerm/paths/workflow_actions/password_reset_action.yaml Normal file
View File

@@ -0,0 +1,15 @@
post:
summary: Create a password reset action
operationId: createPasswordResetAction
description: Create a password reset action
tags:
- workflow actions
requestBody:
$ref: "../../requestBodies/POST/WorkflowActions/PasswordResetAction.yaml"
responses:
'200':
$ref: "../../responses/WorkflowAction.yaml"
'400':
$ref: "../../responses/400.yaml"
'500':
$ref: "../../responses/500.yaml"

15
nerm/paths/workflow_actions/profile_check_action.yaml Normal file
View File

@@ -0,0 +1,15 @@
post:
summary: Create a profile check action
operationId: createProfileCheckAction
description: Create a profile check action
tags:
- workflow actions
requestBody:
$ref: "../../requestBodies/POST/WorkflowActions/ProfileCheckAction.yaml"
responses:
'200':
$ref: "../../responses/WorkflowAction.yaml"
'400':
$ref: "../../responses/400.yaml"
'500':
$ref: "../../responses/500.yaml"

15
nerm/paths/workflow_actions/profile_select_action.yaml Normal file
View File

@@ -0,0 +1,15 @@
post:
summary: Create a profile select action
operationId: createProfileSelectAction
description: Create a profile select action
tags:
- workflow actions
requestBody:
$ref: "../../requestBodies/POST/WorkflowActions/ProfileSelectAction.yaml"
responses:
'200':
$ref: "../../responses/WorkflowAction.yaml"
'400':
$ref: "../../responses/400.yaml"
'500':
$ref: "../../responses/500.yaml"

15
nerm/paths/workflow_actions/request_action.yaml Normal file
View File

@@ -0,0 +1,15 @@
post:
summary: Create a request action
operationId: createRequestAction
description: Create a request action
tags:
- workflow actions
requestBody:
$ref: "../../requestBodies/POST/WorkflowActions/RequestAction.yaml"
responses:
'200':
$ref: "../../responses/WorkflowAction.yaml"
'400':
$ref: "../../responses/400.yaml"
'500':
$ref: "../../responses/500.yaml"

15
nerm/paths/workflow_actions/rest_api_action.yaml Normal file
View File

@@ -0,0 +1,15 @@
post:
summary: Create a REST API action
operationId: createRestApiAction
description: Create a REST API action. Coordinate with rest_api_action_configuration for configuration. Coordinate with api_configuration_attributes for status mapping attributes.
tags:
- workflow actions
requestBody:
$ref: "../../requestBodies/POST/WorkflowActions/RestApiAction.yaml"
responses:
'200':
$ref: "../../responses/WorkflowAction.yaml"
'400':
$ref: "../../responses/400.yaml"
'500':
$ref: "../../responses/500.yaml"

15
nerm/paths/workflow_actions/review_action.yaml Normal file
View File

@@ -0,0 +1,15 @@
post:
summary: Create a review action
operationId: createReviewAction
description: Create a review action. Coordinate with workflow_action_performer_notification_email for performer email config.
tags:
- workflow actions
requestBody:
$ref: "../../requestBodies/POST/WorkflowActions/ReviewAction.yaml"
responses:
'200':
$ref: "../../responses/WorkflowAction.yaml"
'400':
$ref: "../../responses/400.yaml"
'500':
$ref: "../../responses/500.yaml"

15
nerm/paths/workflow_actions/run_workflow_action.yaml Normal file
View File

@@ -0,0 +1,15 @@
post:
summary: Create a run workflow action
operationId: createRunWorkflowAction
description: Create a run workflow action. Coordinate with configuration_profile_attribute.
tags:
- workflow actions
requestBody:
$ref: "../../requestBodies/POST/WorkflowActions/RunWorkflowAction.yaml"
responses:
'200':
$ref: "../../responses/WorkflowAction.yaml"
'400':
$ref: "../../responses/400.yaml"
'500':
$ref: "../../responses/500.yaml"

15
nerm/paths/workflow_actions/set_attributes_action.yaml Normal file
View File

@@ -0,0 +1,15 @@
post:
summary: Create a set attributes action
operationId: createSetAttributesAction
description: Create a set attributes action. Coordinate with workflow_action_set_attributes for the attribute configuration.
tags:
- workflow actions
requestBody:
$ref: "../../requestBodies/POST/WorkflowActions/SetAttributesAction.yaml"
responses:
'200':
$ref: "../../responses/WorkflowAction.yaml"
'400':
$ref: "../../responses/400.yaml"
'500':
$ref: "../../responses/500.yaml"

15
nerm/paths/workflow_actions/set_security_question_action.yaml Normal file
View File

@@ -0,0 +1,15 @@
post:
summary: Create set security question action
operationId: createSetSecurityQuestionAction
description: Create a set security question action
tags:
- workflow actions
requestBody:
$ref: "../../requestBodies/POST/WorkflowActions/SetSecurityQuestionAction.yaml"
responses:
'200':
$ref: "../../responses/WorkflowAction.yaml"
'400':
$ref: "../../responses/400.yaml"
'500':
$ref: "../../responses/500.yaml"

15
nerm/paths/workflow_actions/soap_api_action.yaml Normal file
View File

@@ -0,0 +1,15 @@
post:
summary: Create a SOAP API action
operationId: createSoapApiAction
description: Create a SOAP API action. Coordinates with soap_api_action_configuration for configuration. Coordinates with api_configuration_attributes.
tags:
- workflow actions
requestBody:
$ref: "../../requestBodies/POST/WorkflowActions/SoapApiAction.yaml"
responses:
'200':
$ref: "../../responses/WorkflowAction.yaml"
'400':
$ref: "../../responses/400.yaml"
'500':
$ref: "../../responses/500.yaml"

15
nerm/paths/workflow_actions/status_change_action.yaml Normal file
View File

@@ -0,0 +1,15 @@
post:
summary: Create a status change action
operationId: createStatusChangeAction
description: Create a status change action
tags:
- workflow actions
requestBody:
$ref: "../../requestBodies/POST/WorkflowActions/StatusChangeAction.yaml"
responses:
'200':
$ref: "../../responses/WorkflowAction.yaml"
'400':
$ref: "../../responses/400.yaml"
'500':
$ref: "../../responses/500.yaml"

15
nerm/paths/workflow_actions/unassign_action.yaml Normal file
View File

@@ -0,0 +1,15 @@
post:
summary: Create an unassign action
operationId: createUnassignAction
description: Create an unassign action. Coordinate with workflow_action_roles to assign roles.
tags:
- workflow actions
requestBody:
$ref: "../../requestBodies/POST/WorkflowActions/UnassignAction.yaml"
responses:
'200':
$ref: "../../responses/WorkflowAction.yaml"
'400':
$ref: "../../responses/400.yaml"
'500':
$ref: "../../responses/500.yaml"

15
nerm/paths/workflow_actions/update_profile_action.yaml Normal file
View File

@@ -0,0 +1,15 @@
post:
summary: Create an update profile action
operationId: createUpdateProfileAction
description: Create an update profile action
tags:
- workflow actions
requestBody:
$ref: "../../requestBodies/POST/WorkflowActions/UpdateProfileAction.yaml"
responses:
'200':
$ref: "../../responses/WorkflowAction.yaml"
'400':
$ref: "../../responses/400.yaml"
'500':
$ref: "../../responses/500.yaml"

15
nerm/paths/workflow_actions/username_password_action.yaml Normal file
View File

@@ -0,0 +1,15 @@
post:
summary: Create a username password action
operationId: createUsernamePasswordAction
description: Create a username password action
tags:
- workflow actions
requestBody:
$ref: "../../requestBodies/POST/WorkflowActions/UsernamePasswordAction.yaml"
responses:
'200':
$ref: "../../responses/WorkflowAction.yaml"
'400':
$ref: "../../responses/400.yaml"
'500':
$ref: "../../responses/500.yaml"

9
nerm/requestBodies/POST/WorkflowActions/ApprovalAction.yaml Normal file
View File

@@ -0,0 +1,9 @@
required: true
content:
application/json:
schema:
type: object
properties:
workflow_action:
type: object
$ref: "../../../schemas/POST/WorkflowActions/ApprovalAction.yaml"

9
nerm/requestBodies/POST/WorkflowActions/AskSecurityQuestionAction.yaml Normal file
View File

@@ -0,0 +1,9 @@
required: true
content:
application/json:
schema:
type: object
properties:
workflow_action:
type: object
$ref: "../../../schemas/POST/WorkflowActions/AskSecurityQuestionAction.yaml"

9
nerm/requestBodies/POST/WorkflowActions/AutoAssignAction.yaml Normal file
View File

@@ -0,0 +1,9 @@
required: true
content:
application/json:
schema:
type: object
properties:
workflow_action:
type: object
$ref: "../../../schemas/POST/WorkflowActions/AutoAssignAction.yaml"

9
nerm/requestBodies/POST/WorkflowActions/BatchUpdateAction.yaml Normal file
View File

@@ -0,0 +1,9 @@
required: true
content:
application/json:
schema:
type: object
properties:
workflow_action:
type: object
$ref: "../../../schemas/POST/WorkflowActions/BatchUpdateAction.yaml"

9
nerm/requestBodies/POST/WorkflowActions/CloseSessionAction.yaml Normal file
View File

@@ -0,0 +1,9 @@
required: true
content:
application/json:
schema:
type: object
properties:
workflow_action:
type: object
$ref: "../../../schemas/POST/WorkflowActions/CloseSessionAction.yaml"

9
nerm/requestBodies/POST/WorkflowActions/ContributorsAction.yaml Normal file
View File

@@ -0,0 +1,9 @@
required: true
content:
application/json:
schema:
type: object
properties:
workflow_action:
type: object
$ref: "../../../schemas/POST/WorkflowActions/ContributorsAction.yaml"

9
nerm/requestBodies/POST/WorkflowActions/CreateProfileAction.yaml Normal file
View File

@@ -0,0 +1,9 @@
required: true
content:
application/json:
schema:
type: object
properties:
workflow_action:
type: object
$ref: "../../../schemas/POST/WorkflowActions/CreateProfileAction.yaml"

9
nerm/requestBodies/POST/WorkflowActions/DuplicatePreventionAction.yaml Normal file
View File

@@ -0,0 +1,9 @@
required: true
content:
application/json:
schema:
type: object
properties:
workflow_action:
type: object
$ref: "../../../schemas/POST/WorkflowActions/DuplicatePreventionAction.yaml"

9
nerm/requestBodies/POST/WorkflowActions/EmailVerificationAction.yaml Normal file
View File

@@ -0,0 +1,9 @@
required: true
content:
application/json:
schema:
type: object
properties:
workflow_action:
type: object
$ref: "../../../schemas/POST/WorkflowActions/EmailVerificationAction.yaml"

9
nerm/requestBodies/POST/WorkflowActions/FulfillmentAction.yaml Normal file
View File

@@ -0,0 +1,9 @@
required: true
content:
application/json:
schema:
type: object
properties:
workflow_action:
type: object
$ref: "../../../schemas/POST/WorkflowActions/FulfillmentAction.yaml"

9
nerm/requestBodies/POST/WorkflowActions/IdentityProofingAction.yaml Normal file
View File

@@ -0,0 +1,9 @@
required: true
content:
application/json:
schema:
type: object
properties:
workflow_action:
type: object
$ref: "../../../schemas/POST/WorkflowActions/IdentityProofingAction.yaml"

9
nerm/requestBodies/POST/WorkflowActions/InvitationAction.yaml Normal file
View File

@@ -0,0 +1,9 @@
required: true
content:
application/json:
schema:
type: object
properties:
workflow_action:
type: object
$ref: "../../../schemas/POST/WorkflowActions/InvitationAction.yaml"

9
nerm/requestBodies/POST/WorkflowActions/LdapAction.yaml Normal file
View File

@@ -0,0 +1,9 @@
required: true
content:
application/json:
schema:
type: object
properties:
workflow_action:
type: object
$ref: "../../../schemas/POST/WorkflowActions/LdapAction.yaml"

9
nerm/requestBodies/POST/WorkflowActions/NotificationAction.yaml Normal file
View File

@@ -0,0 +1,9 @@
required: true
content:
application/json:
schema:
type: object
properties:
workflow_action:
type: object
$ref: "../../../schemas/POST/WorkflowActions/NotificationAction.yaml"

9
nerm/requestBodies/POST/WorkflowActions/PasswordResetAction.yaml Normal file
View File

@@ -0,0 +1,9 @@
required: true
content:
application/json:
schema:
type: object
properties:
workflow_action:
type: object
$ref: "../../../schemas/POST/WorkflowActions/PasswordResetAction.yaml"

9
nerm/requestBodies/POST/WorkflowActions/ProfileCheckAction.yaml Normal file
View File

@@ -0,0 +1,9 @@
required: true
content:
application/json:
schema:
type: object
properties:
workflow_action:
type: object
$ref: "../../../schemas/POST/WorkflowActions/ProfileCheckAction.yaml"

9
nerm/requestBodies/POST/WorkflowActions/ProfileSelectAction.yaml Normal file
View File

@@ -0,0 +1,9 @@
required: true
content:
application/json:
schema:
type: object
properties:
workflow_action:
type: object
$ref: "../../../schemas/POST/WorkflowActions/ProfileSelectAction.yaml"

9
nerm/requestBodies/POST/WorkflowActions/RequestAction.yaml Normal file
View File

@@ -0,0 +1,9 @@
required: true
content:
application/json:
schema:
type: object
properties:
workflow_action:
type: object
$ref: "../../../schemas/POST/WorkflowActions/RequestAction.yaml"

9
nerm/requestBodies/POST/WorkflowActions/RestApiAction.yaml Normal file
View File

@@ -0,0 +1,9 @@
required: true
content:
application/json:
schema:
type: object
properties:
workflow_action:
type: object
$ref: "../../../schemas/POST/WorkflowActions/RestApiAction.yaml"

9
nerm/requestBodies/POST/WorkflowActions/ReviewAction.yaml Normal file
View File

@@ -0,0 +1,9 @@
required: true
content:
application/json:
schema:
type: object
properties:
workflow_action:
type: object
$ref: "../../../schemas/POST/WorkflowActions/ReviewAction.yaml"

9
nerm/requestBodies/POST/WorkflowActions/RunWorkflowAction.yaml Normal file
View File

@@ -0,0 +1,9 @@
required: true
content:
application/json:
schema:
type: object
properties:
workflow_action:
type: object
$ref: "../../../schemas/POST/WorkflowActions/RunWorkflowAction.yaml"

9
nerm/requestBodies/POST/WorkflowActions/SetAttributesAction.yaml Normal file
View File

@@ -0,0 +1,9 @@
required: true
content:
application/json:
schema:
type: object
properties:
workflow_action:
type: object
$ref: "../../../schemas/POST/WorkflowActions/SetAttributesAction.yaml"

9
nerm/requestBodies/POST/WorkflowActions/SetSecurityQuestionAction.yaml Normal file
View File

@@ -0,0 +1,9 @@
required: true
content:
application/json:
schema:
type: object
properties:
workflow_action:
type: object
$ref: "../../../schemas/POST/WorkflowActions/SetSecurityQuestionAction.yaml"

9
nerm/requestBodies/POST/WorkflowActions/SoapApiAction.yaml Normal file
View File

@@ -0,0 +1,9 @@
required: true
content:
application/json:
schema:
type: object
properties:
workflow_action:
type: object
$ref: "../../../schemas/POST/WorkflowActions/SoapApiAction.yaml"

9
nerm/requestBodies/POST/WorkflowActions/StatusChangeAction.yaml Normal file
View File

@@ -0,0 +1,9 @@
required: true
content:
application/json:
schema:
type: object
properties:
workflow_action:
type: object
$ref: "../../../schemas/POST/WorkflowActions/StatusChangeAction.yaml"

9
nerm/requestBodies/POST/WorkflowActions/UnassignAction.yaml Normal file
View File

@@ -0,0 +1,9 @@
required: true
content:
application/json:
schema:
type: object
properties:
workflow_action:
type: object
$ref: "../../../schemas/POST/WorkflowActions/UnassignAction.yaml"

9
nerm/requestBodies/POST/WorkflowActions/UpdateProfileAction.yaml Normal file
View File

@@ -0,0 +1,9 @@
required: true
content:
application/json:
schema:
type: object
properties:
workflow_action:
type: object
$ref: "../../../schemas/POST/WorkflowActions/UpdateProfileAction.yaml"

9
nerm/requestBodies/POST/WorkflowActions/UsernamePasswordAction.yaml Normal file
View File

@@ -0,0 +1,9 @@
required: true
content:
application/json:
schema:
type: object
properties:
workflow_action:
type: object
$ref: "../../../schemas/POST/WorkflowActions/UsernamePasswordAction.yaml"

9
nerm/responses/WorkflowAction.yaml Normal file
View File

@@ -0,0 +1,9 @@
description: Expected response to a valid request
content:
application/json:
schema:
type: object
properties:
workflow_action:
type: object
$ref: '../schemas/GET/WorkflowAction.yaml'

59
nerm/schemas/GET/WorkflowAction.yaml Normal file
View File

@@ -0,0 +1,59 @@
type: object
properties:
workflow_id:
type: string
format: uuid
required: true
description: The workflow the workflow action belongs to.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
description:
type: string
required: false
description: The description of the workflow action.
example: Require approval from another user or a group of users with a specific role.
page_id:
type: string
format: uuid
required: true
description: The page the workflow action should render.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
add_requester_as_owner:
type: boolean
default: true
description: If the requester should be added as the owner of the profile to be created.
example: true
email_attribute_id:
type: string
format: uuid
required: false
description: The attribute storing the email address for the workflow action.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
email_addresses:
type: array
required: false
items:
type: string
format: text
description: The email addresses for the workflow action.
example: ["johndoe@gmail.com", "janedoe@gmail.com"]
new_status:
type: string
format: text
required: false
description: The new status for the Status Change workflow action.
example: Active, Inactive, On Leave, Terminated
archived:
type: boolean
default: false
description: If the workflow action is archived or not.
example: false
skippable:
type: boolean
default: false
description: If the workflow action is skippable or not.
example: false
requires_comment:
type: boolean
default: false
description: If the workflow action requires a comment or not.
example: false

34
nerm/schemas/POST/WorkflowActions/ApprovalAction.yaml Normal file
View File

@@ -0,0 +1,34 @@
type: object
properties:
workflow_id:
type: string
format: uuid
required: true
description: The workflow the workflow action belongs to.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
description:
type: string
required: false
description: The description of the workflow action.
example: Require approval from another user or a group of users with a specific role.
page_id:
type: string
format: uuid
required: true
description: The page the workflow action should render.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
archived:
type: boolean
default: false
description: If the workflow action is archived or not.
example: false
skippable:
type: boolean
default: false
description: If the workflow action is skippable or not.
example: false
requires_comment:
type: boolean
default: false
description: If the workflow action requires a comment or not.
example: false

36
nerm/schemas/POST/WorkflowActions/AskSecurityQuestionAction.yaml Normal file
View File

@@ -0,0 +1,36 @@
type: object
properties:
workflow_id:
type: string
format: uuid
required: true
description: The workflow the workflow action belongs to.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
description:
type: string
required: true
description: The description of the workflow action.
example: Prompt the user to answer some personal security questions.
number_of_questions:
type: integer
format: int32
required: true
description: The number of questions the user should answer upon login.
example: 1
token_expiration:
type: integer
format: int32
required: true
description: The token expiration time, coordinates with token_expiration_type.
example: 1
token_expiration_type:
type: string
required: true
enum: [hours, days, login attempts, always]
description: The token expiration type, coordinates with token_expiration.
example: day
archived:
type: boolean
default: false
description: If the workflow action is archived or not.
example: false

24
nerm/schemas/POST/WorkflowActions/AutoAssignAction.yaml Normal file
View File

@@ -0,0 +1,24 @@
type: object
properties:
workflow_id:
type: string
format: uuid
required: true
description: The workflow the workflow action belongs to.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
description:
type: string
required: true
description: The description of the workflow action.
example: Automatically assigns contributors to this profile.
archived:
type: boolean
default: false
description: If the workflow action is archived or not.
example: false
contributor_attr:
type: string
format: uuid
required: false
description: The id of the contributor attribute for contributors from another profile. If workflow_action_roles are not associated to this object, this is required.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8

18
nerm/schemas/POST/WorkflowActions/BatchUpdateAction.yaml Normal file
View File

@@ -0,0 +1,18 @@
type: object
properties:
workflow_id:
type: string
format: uuid
required: true
description: The workflow the workflow action belongs to.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
description:
type: string
required: true
description: The description of the workflow action.
example: Updates a batch of profiles with all attributes collected during the workflow.
archived:
type: boolean
default: false
description: If the workflow action is archived or not.
example: false

18
nerm/schemas/POST/WorkflowActions/CloseSessionAction.yaml Normal file
View File

@@ -0,0 +1,18 @@
type: object
properties:
workflow_id:
type: string
format: uuid
required: true
description: The workflow the workflow action belongs to.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
description:
type: string
required: true
description: The description of the workflow action.
example: Closes the current workflow session.
archived:
type: boolean
default: false
description: If the workflow action is archived or not.
example: false

36
nerm/schemas/POST/WorkflowActions/ContributorsAction.yaml Normal file
View File

@@ -0,0 +1,36 @@
type: object
properties:
workflow_id:
type: string
format: uuid
required: true
description: The workflow the workflow action belongs to.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
description:
type: string
required: true
description: The description of the workflow action.
example: Have the requester determine the contributors or owner of the profile.
owner:
type: string
required: false
enum: [true, false]
description: If the assignment option should be an owner. Owner, Contributors, or Roles must be chosen.
example: "true"
contributors:
type: string
required: false
enum: [true, false]
description: If the assignment option should be contributors. Owner, Contributors, or Roles must be chosen.
example: "true"
roles:
type: string
required: false
enum: [true, false]
description: If the assignment option should be roles. Owner, Contributors, or Roles must be chosen.
example: "true"
archived:
type: boolean
default: false
description: If the workflow action is archived or not.
example: false

23
nerm/schemas/POST/WorkflowActions/CreateProfileAction.yaml Normal file
View File

@@ -0,0 +1,23 @@
type: object
properties:
workflow_id:
type: string
format: uuid
required: true
description: The workflow the workflow action belongs to.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
description:
type: string
required: true
description: The description of the workflow action.
example: Creates a profile with all attributes collected during the workflow.
add_requester_as_owner:
type: boolean
default: true
description: If the requester should be added as the owner of the profile to be created.
example: true
archived:
type: boolean
default: false
description: If the workflow action is archived or not.
example: false

34
nerm/schemas/POST/WorkflowActions/DuplicatePreventionAction.yaml Normal file
View File

@@ -0,0 +1,34 @@
type: object
properties:
workflow_id:
type: string
format: uuid
required: true
description: The workflow the workflow action belongs to.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
description:
type: string
required: true
description: The description of the workflow action.
example: Allows a user to select an already existing profile, or create a new one for the request.
search_scope:
type: string
required: true
enum: ["all", "current"]
description: The search scope of the profiles to check against.
example: "current"
ne_attribute_ids:
type: array
required: false
description: An array of ne_attribute_ids.
example: ["33f072dd-13b4-41e1-8ea0-16f2a59b57c8"]
handle_id:
type: string
required: false
description: The handle id.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
archived:
type: boolean
default: false
description: If the workflow action is archived or not.
example: false

36
nerm/schemas/POST/WorkflowActions/EmailVerificationAction.yaml Normal file
View File

@@ -0,0 +1,36 @@
type: object
properties:
workflow_id:
type: string
format: uuid
required: true
description: The workflow the workflow action belongs to.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
description:
type: string
required: true
description: The description of the workflow action.
example: Have the user verify their email address.
email_expiration:
type: integer
format: int32
required: true
description: The email expiration time, in minutes.
example: 20
token_expiration:
type: integer
format: int32
required: true
description: The token expiration time, coordinates with token_expiration_type.
example: 1
token_expiration_type:
type: string
required: true
enum: [hours, days, login attempts, always]
description: The token expiration type, coordinates with token_expiration.
example: day
archived:
type: boolean
default: false
description: If the workflow action is archived or not.
example: false

29
nerm/schemas/POST/WorkflowActions/FulfillmentAction.yaml Normal file
View File

@@ -0,0 +1,29 @@
type: object
properties:
workflow_id:
type: string
format: uuid
required: true
description: The workflow the workflow action belongs to.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
description:
type: string
required: true
description: The description of the workflow action.
example: Have another user or group provide information for the profile.
page_id:
type: string
format: uuid
required: false
description: The page the workflow action should render.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
archived:
type: boolean
default: false
description: If the workflow action is archived or not.
example: false
requires_comment:
type: boolean
default: false
description: If the workflow action requires a comment or not.
example: false

18
nerm/schemas/POST/WorkflowActions/IdentityProofingAction.yaml Normal file
View File

@@ -0,0 +1,18 @@
type: object
properties:
workflow_id:
type: string
format: uuid
required: true
description: The workflow the workflow action belongs to.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
description:
type: string
required: true
description: The description of the workflow action.
example: Have the user account associated with this profile validate the identity data.
archived:
type: boolean
default: false
description: If the workflow action is archived or not.
example: false

94
nerm/schemas/POST/WorkflowActions/InvitationAction.yaml Normal file
View File

@@ -0,0 +1,94 @@
type: object
properties:
workflow_id:
type: string
format: uuid
required: true
description: The workflow the workflow action belongs to.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
description:
type: string
required: true
description: The description of the workflow action.
example: Creates a registration session associated with an email address
archived:
type: boolean
default: false
description: If the workflow action is archived or not.
example: false
configuration_attributes:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
description: the id.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
workflow_id:
type: string
format: uuid
description: the id of the workflow.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
wait_for_completion:
type: boolean
example: false
description: If the invitation action should pause the parent workflow to wait for completion.
return_profile:
type: boolean
example: false
description: If the invitation action should return a profile.
portal_id:
type: string
format: uuid
description: the id of the portal.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
registration_workflow_id:
type: string
format: uuid
description: the id of the registration workflow.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
email_attribute_id:
type: string
format: uuid
description: the id of the email attribute.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
profile_type_id:
type: string
format: uuid
description: the id of the profile type.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
validate_completed_registration:
type: boolean
example: false
description: If the action should validate against completed registrations by email address.
validate_open_registration:
type: boolean
example: false
description: If the action should validate against open registrations by email address.
workflow_action_email_attributes:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
description: the id.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
workflow_action_id:
type: string
format: uuid
description: the id of the workflow action.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
email_id:
type: string
format: uuid
description: the id of the email.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
type:
type: string
description: the type of email.
enum: [StandardEmail, PerformerNotificationEmail, ApprovalEmail, RejectionEmail]
example: StandardEmail

89
nerm/schemas/POST/WorkflowActions/LdapAction.yaml Normal file
View File

@@ -0,0 +1,89 @@
type: object
properties:
workflow_id:
type: string
format: uuid
required: true
description: The workflow the workflow action belongs to.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
description:
type: string
required: true
description: The description of the workflow action.
example: Create a Collaboration user account for this profile.
archived:
type: boolean
default: false
description: If the workflow action is archived or not.
example: false
store_type:
type: string
required: true
enum: [Local, Directory]
description: the type of store.
example: Local
ldap_action_user_roles_attributes:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
description: the id.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
role_id:
type: string
format: uuid
description: the id of the role.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
workflow_action_value_builders_attributes:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
description: the id.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
workflow_action_id:
type: string
format: uuid
description: the id of the workflow action.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
value_builder_id:
type: string
format: uuid
description: the id of the value builder.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
position:
type: integer
format: int32
description: the position of the value builder attribute.
example: 1
workflow_action_directory_groups_attributes:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
description: the id.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
directory_id:
type: string
format: uuid
description: the id of the directory.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
group_label:
type: string
format: text
description: the group label.
example: Admin
group_dn:
type: string
format: text
description: the group dn.
example: group

57
nerm/schemas/POST/WorkflowActions/NotificationAction.yaml Normal file
View File

@@ -0,0 +1,57 @@
type: object
properties:
workflow_id:
type: string
format: uuid
required: true
description: The workflow the workflow action belongs to.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
description:
type: string
required: true
description: The description of the workflow action.
example: Send a notification to a group of users.
email_attribute_id:
type: string
format: uuid
required: false
description: The attribute storing the email address for the workflow action.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
email_addresses:
type: array
required: false
items:
type: string
format: text
description: The email addresses for the workflow action.
example: ["johndoe@gmail.com", "janedoe@gmail.com"]
archived:
type: boolean
default: false
description: If the workflow action is archived or not.
example: false
workflow_action_email_attributes:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
description: the id.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
workflow_action_id:
type: string
format: uuid
description: the id of the workflow action.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
email_id:
type: string
format: uuid
description: the id of the email.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
type:
type: string
enum: [StandardEmail]
description: the type of email.
example: StandardEmail

18
nerm/schemas/POST/WorkflowActions/PasswordResetAction.yaml Normal file
View File

@@ -0,0 +1,18 @@
type: object
properties:
workflow_id:
type: string
format: uuid
required: true
description: The workflow the workflow action belongs to.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
description:
type: string
required: true
description: The description of the workflow action.
example: Prompt the user to reset their password.
archived:
type: boolean
default: false
description: If the workflow action is archived or not.
example: false

34
nerm/schemas/POST/WorkflowActions/ProfileCheckAction.yaml Normal file
View File

@@ -0,0 +1,34 @@
type: object
properties:
workflow_id:
type: string
format: uuid
required: true
description: The workflow the workflow action belongs to.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
description:
type: string
required: true
description: The description of the workflow action.
example: Finds a profile based on selected attributes and values found in the session.
archived:
type: boolean
default: false
description: If the workflow action is archived or not.
example: false
ne_attribute_ids:
type: array
required: false
description: An array of ne_attribute_ids.
example: ["33f072dd-13b4-41e1-8ea0-16f2a59b57c8"]
handle_type:
type: string
required: false
enum: [session, attribute]
description: The handle type for what should happen if an existing profile is found.
example: session
handle_id:
type: string
required: false
description: The handle id. When handle type is session, this is the session id.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8

18
nerm/schemas/POST/WorkflowActions/ProfileSelectAction.yaml Normal file
View File

@@ -0,0 +1,18 @@
type: object
properties:
workflow_id:
type: string
format: uuid
required: true
description: The workflow the workflow action belongs to.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
description:
type: string
required: true
description: The description of the workflow action.
example: Select the profiles that you want to run this workflow for.
archived:
type: boolean
default: false
description: If the workflow action is archived or not.
example: false

29
nerm/schemas/POST/WorkflowActions/RequestAction.yaml Normal file
View File

@@ -0,0 +1,29 @@
type: object
properties:
workflow_id:
type: string
format: uuid
required: true
description: The workflow the workflow action belongs to.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
description:
type: string
required: true
description: The description of the workflow action.
example: Provides the requester a page with forms.
page_id:
type: string
format: uuid
required: false
description: The page the workflow action should render.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
archived:
type: boolean
default: false
description: If the workflow action is archived or not.
example: false
requires_comment:
type: boolean
default: false
description: If the workflow action requires a comment or not.
example: false

18
nerm/schemas/POST/WorkflowActions/RestApiAction.yaml Normal file
View File

@@ -0,0 +1,18 @@
type: object
properties:
workflow_id:
type: string
format: uuid
required: true
description: The workflow the workflow action belongs to.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
description:
type: string
required: true
description: The description of the workflow action.
example: Makes a request to a Restful API.
archived:
type: boolean
default: false
description: If the workflow action is archived or not.
example: false

29
nerm/schemas/POST/WorkflowActions/ReviewAction.yaml Normal file
View File

@@ -0,0 +1,29 @@
type: object
properties:
workflow_id:
type: string
format: uuid
required: true
description: The workflow the workflow action belongs to.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
description:
type: string
required: true
description: The description of the workflow action.
example: Allows the requester to review.
page_id:
type: string
format: uuid
required: false
description: The page the workflow action should render.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
archived:
type: boolean
default: false
description: If the workflow action is archived or not.
example: false
requires_comment:
type: boolean
default: false
description: If the workflow action requires a comment or not.
example: false

61
nerm/schemas/POST/WorkflowActions/RunWorkflowAction.yaml Normal file
View File

@@ -0,0 +1,61 @@
type: object
properties:
workflow_id:
type: string
format: uuid
required: true
description: The workflow the workflow action belongs to.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
description:
type: string
required: true
description: The description of the workflow action.
example: Runs another workflow with the ability to pass data in between.
archived:
type: boolean
default: false
description: If the workflow action is archived or not.
example: false
configuration_attributes:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
description: the id.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
workflow_id:
type: string
format: uuid
description: the id of the workflow.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
wait_for_completion:
type: boolean
description: If the parent workflow should wait for the child to complete.
example: false
profile_to_send:
type: string
enum: [none, current, attribute, profile_type]
description: the profile the parent should send to the child workflow.
example: current
return_profile:
type: boolean
description: if the child workflow should return a profile.
example: false
run_workflow_action_id:
type: string
format: uuid
description: the id of the child workflow to run.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
email_attribute_id:
type: string
format: uuid
description: the id of the email attribute.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
profile_type_id:
type: string
format: uuid
description: the id of the profile type.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8

18
nerm/schemas/POST/WorkflowActions/SetAttributesAction.yaml Normal file
View File

@@ -0,0 +1,18 @@
type: object
properties:
workflow_id:
type: string
format: uuid
required: true
description: The workflow the workflow action belongs to.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
description:
type: string
required: true
description: The description of the workflow action.
example: Set attribute(s) to a specific value.
archived:
type: boolean
default: false
description: If the workflow action is archived or not.
example: false

24
nerm/schemas/POST/WorkflowActions/SetSecurityQuestionAction.yaml Normal file
View File

@@ -0,0 +1,24 @@
type: object
properties:
workflow_id:
type: string
format: uuid
required: true
description: The workflow the workflow action belongs to.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
description:
type: string
required: true
description: The description of the workflow action.
example: Prompt the user to provide some personal security questions and answers.
archived:
type: boolean
default: false
description: If the workflow action is archived or not.
example: false
number_of_questions:
type: integer
format: int32
required: true
description: The number of questions the user should answer upon login.
example: 1

18
nerm/schemas/POST/WorkflowActions/SoapApiAction.yaml Normal file
View File

@@ -0,0 +1,18 @@
type: object
properties:
workflow_id:
type: string
format: uuid
required: true
description: The workflow the workflow action belongs to.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
description:
type: string
required: true
description: The description of the workflow action.
example: Makes a request to a SOAP API.
archived:
type: boolean
default: false
description: If the workflow action is archived or not.
example: false

25
nerm/schemas/POST/WorkflowActions/StatusChangeAction.yaml Normal file
View File

@@ -0,0 +1,25 @@
type: object
properties:
workflow_id:
type: string
format: uuid
required: true
description: The workflow the workflow action belongs to.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
description:
type: string
required: true
description: The description of the workflow action.
example: Changes the status of a non-employee.
new_status:
type: string
format: text
required: false
enum: [Active, Inactive, On Leave, Terminated]
description: The new status for the Status Change workflow action.
example: Active
archived:
type: boolean
default: false
description: If the workflow action is archived or not.
example: false

18
nerm/schemas/POST/WorkflowActions/UnassignAction.yaml Normal file
View File

@@ -0,0 +1,18 @@
type: object
properties:
workflow_id:
type: string
format: uuid
required: true
description: The workflow the workflow action belongs to.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
description:
type: string
required: true
description: The description of the workflow action.
example: Un-assigns roles from a profile.
archived:
type: boolean
default: false
description: If the workflow action is archived or not.
example: false

18
nerm/schemas/POST/WorkflowActions/UpdateProfileAction.yaml Normal file
View File

@@ -0,0 +1,18 @@
type: object
properties:
workflow_id:
type: string
format: uuid
required: true
description: The workflow the workflow action belongs to.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
description:
type: string
required: true
description: The description of the workflow action.
example: Updates a profile with all attributes collected during the workflow.
archived:
type: boolean
default: false
description: If the workflow action is archived or not.
example: false

18
nerm/schemas/POST/WorkflowActions/UsernamePasswordAction.yaml Normal file
View File

@@ -0,0 +1,18 @@
type: object
properties:
workflow_id:
type: string
format: uuid
required: true
description: The workflow the workflow action belongs to.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
description:
type: string
required: true
description: The description of the workflow action.
example: Prompt the user for their username and password.
archived:
type: boolean
default: false
description: If the workflow action is archived or not.
example: false