mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-09 12:27:48 +00:00
eaf286ccae
* IDNWAIMEA-10186: Update API Docs for MandatoryCommentRequirement * Add MandatoryCommentRequirement to examples * Add mandatoryComment to campaign reference * Update CampaignReference.yaml * Update CampaignReference.yaml * fix indentation error in CampaignReference * Add mandatoryCommentRequirement for v3 add the mandatoryCommentRequirement to campaign FULL responses and the create campaign payloads * add mandatoryComment to beta create campaign and templates * add mandatory comment to v3 campaign schema * add type string to mandatoryCommentRequirement * Update mandatoryCommentRequirement description.' by github action: 5245808520
55 lines
1.6 KiB
YAML
55 lines
1.6 KiB
YAML
type: object
|
|
required:
|
|
- id
|
|
- name
|
|
- type
|
|
- campaignType
|
|
- description
|
|
- correlatedStatus
|
|
- mandatoryCommentRequirement
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The unique ID of the campaign.
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
name:
|
|
type: string
|
|
description: The name of the campaign.
|
|
example: 'Campaign Name'
|
|
type:
|
|
type: string
|
|
enum:
|
|
- CAMPAIGN
|
|
description: The type of object that is being referenced.
|
|
example: CAMPAIGN
|
|
campaignType:
|
|
type: string
|
|
enum:
|
|
- MANAGER
|
|
- SOURCE_OWNER
|
|
- SEARCH
|
|
description: The type of the campaign.
|
|
example: MANAGER
|
|
description:
|
|
type: string
|
|
description: The description of the campaign set by the admin who created it.
|
|
nullable: true
|
|
example: 'A description of the campaign'
|
|
correlatedStatus:
|
|
description: >-
|
|
The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated.
|
|
An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).
|
|
enum:
|
|
- "CORRELATED"
|
|
- "UNCORRELATED"
|
|
example: CORRELATED
|
|
mandatoryCommentRequirement:
|
|
type: string
|
|
description: >-
|
|
Determines whether comments are required for decisions during certification reviews. You can require comments
|
|
for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions.
|
|
enum:
|
|
- "ALL_DECISIONS"
|
|
- "REVOKE_ONLY_DECISIONS"
|
|
- "NO_DECISIONS"
|
|
example: NO_DECISIONS |