mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-08 20:37:48 +00:00
96 lines
2.8 KiB
YAML
96 lines
2.8 KiB
YAML
type: object
|
|
properties:
|
|
profile_type_id:
|
|
type: string
|
|
format: uuid
|
|
required: true
|
|
description: The profile type the workflow effects.
|
|
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
|
|
status:
|
|
type: string
|
|
enum: [Enabled, Disabled]
|
|
required: true
|
|
description: Whether or not the workflow is enabled or disabled.
|
|
example: Enabled
|
|
uid:
|
|
type: string
|
|
required: true
|
|
description: The uid of the workflow.
|
|
example: my_uid
|
|
name:
|
|
type: string
|
|
required: true
|
|
description: Name of the workflow
|
|
example: my_workflow
|
|
condition_rules_attributes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
logical_operator:
|
|
type: string
|
|
enum: ["AND", "OR"]
|
|
required: true
|
|
description: The type of condition rule.
|
|
example: "RiskRule"
|
|
comparison_operator:
|
|
type: string
|
|
enum: ["<", ">", "==", "before", "include?", "absent?", "after"]
|
|
required: true
|
|
description: The operator used by the condition rule.
|
|
example: ">"
|
|
condition_object_id:
|
|
type: string
|
|
required: false
|
|
description: UUID for object targeted by the condition.
|
|
example: "cc844e99-9895-43d0-9d17-8f606b2158ba"
|
|
condition_object_type:
|
|
type: string
|
|
required: false
|
|
description: Type of object targeted by the condition.
|
|
example: "DateAttribute"
|
|
secondary_value:
|
|
type: string
|
|
required: false
|
|
description: Used for time_frame comparison.
|
|
example: "before"
|
|
tertiary_value:
|
|
type: string
|
|
required: false
|
|
description: Represents the days of a temporal comparison.
|
|
example: "before"
|
|
value:
|
|
type: string
|
|
required: false
|
|
description: The value being compared against.
|
|
example: "before"
|
|
order:
|
|
type: integer
|
|
format: int32
|
|
required: false
|
|
description: If there are multiple rules against one workflow, this is the order that they are ran in.
|
|
example: 1
|
|
type:
|
|
type: string
|
|
enum: [
|
|
"RiskRule",
|
|
"ProfileIdRule",
|
|
"ProfileTypeRule",
|
|
"ProfileExistsRule",
|
|
"ProfileStatusRule",
|
|
"SessionAttributeRule",
|
|
"ProfileAttributeRule",
|
|
"ProfileDoesNotExistRule",
|
|
"IdentityProofingRule"
|
|
]
|
|
required: true
|
|
description: The type of condition rule.
|
|
example: "ProfileIdRule"
|
|
description: The ProfileTypeRule this workflow will be working with.
|
|
example: [{
|
|
"type": "ProfileTypeRule",
|
|
"condition_type": "Workflow",
|
|
"comparison_operator": "==",
|
|
"logical_operator": "AND",
|
|
"value": "true",
|
|
}] |