diff --git a/static/api-specs/idn/beta/schemas/Campaign.yaml b/static/api-specs/idn/beta/schemas/Campaign.yaml index fb4e6c0f7..6eb6511a5 100644 --- a/static/api-specs/idn/beta/schemas/Campaign.yaml +++ b/static/api-specs/idn/beta/schemas/Campaign.yaml @@ -16,6 +16,14 @@ allOf: format: date-time description: Modified time of the campaign example: '2020-03-03T22:20:12.674Z' + 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 filter: type: object description: >- diff --git a/static/api-specs/idn/beta/schemas/CertificationReference.yaml b/static/api-specs/idn/beta/schemas/CertificationReference.yaml index f922102eb..e6a28b4bd 100644 --- a/static/api-specs/idn/beta/schemas/CertificationReference.yaml +++ b/static/api-specs/idn/beta/schemas/CertificationReference.yaml @@ -13,12 +13,11 @@ properties: enum: - "CERTIFICATION" example: CERTIFICATION -example: - reviewer: - email: reviewer@test.com - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - name: William Wilson - type: CERTIFICATION - id: 2c9180867921dd73017923ddd8d203ba - name: Identity Access Review for William Wilson + 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 diff --git a/static/api-specs/idn/beta/schemas/SlimCampaign.yaml b/static/api-specs/idn/beta/schemas/SlimCampaign.yaml index 0d6ecdc26..6d0f8061c 100644 --- a/static/api-specs/idn/beta/schemas/SlimCampaign.yaml +++ b/static/api-specs/idn/beta/schemas/SlimCampaign.yaml @@ -65,4 +65,13 @@ properties: - COMPLETED - ERROR - ARCHIVED - example: ACTIVE \ No newline at end of file + example: ACTIVE + correlatedStatus: + type: string + 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 \ No newline at end of file diff --git a/static/api-specs/idn/beta/schemas/campaign/examples/CampaignTemplateManager.yaml b/static/api-specs/idn/beta/schemas/campaign/examples/CampaignTemplateManager.yaml index a56d70e88..a6be8ed07 100644 --- a/static/api-specs/idn/beta/schemas/campaign/examples/CampaignTemplateManager.yaml +++ b/static/api-specs/idn/beta/schemas/campaign/examples/CampaignTemplateManager.yaml @@ -35,6 +35,7 @@ value: emailNotificationEnabled: true autoRevokeAllowed: false recommendationsEnabled: false + correlatedStatus: CORRELATED \ No newline at end of file diff --git a/static/api-specs/idn/beta/schemas/campaign/examples/CampaignTemplateRoleComposition.yaml b/static/api-specs/idn/beta/schemas/campaign/examples/CampaignTemplateRoleComposition.yaml index 364e3125d..0c7bceea2 100644 --- a/static/api-specs/idn/beta/schemas/campaign/examples/CampaignTemplateRoleComposition.yaml +++ b/static/api-specs/idn/beta/schemas/campaign/examples/CampaignTemplateRoleComposition.yaml @@ -42,4 +42,5 @@ value: emailNotificationEnabled: false autoRevokeAllowed: false recommendationsEnabled: false + correlatedStatus: CORRELATED \ No newline at end of file diff --git a/static/api-specs/idn/beta/schemas/campaign/examples/CampaignTemplateSearch.yaml b/static/api-specs/idn/beta/schemas/campaign/examples/CampaignTemplateSearch.yaml index ba5a7c07f..7a6f0c8a9 100644 --- a/static/api-specs/idn/beta/schemas/campaign/examples/CampaignTemplateSearch.yaml +++ b/static/api-specs/idn/beta/schemas/campaign/examples/CampaignTemplateSearch.yaml @@ -41,4 +41,5 @@ value: status: null emailNotificationEnabled: true autoRevokeAllowed: false - recommendationsEnabled: false \ No newline at end of file + recommendationsEnabled: false + correlatedStatus: CORRELATED \ No newline at end of file diff --git a/static/api-specs/idn/beta/schemas/campaign/examples/CampaignTemplateSourceOwner.yaml b/static/api-specs/idn/beta/schemas/campaign/examples/CampaignTemplateSourceOwner.yaml index 2620d36c7..95b16db9c 100644 --- a/static/api-specs/idn/beta/schemas/campaign/examples/CampaignTemplateSourceOwner.yaml +++ b/static/api-specs/idn/beta/schemas/campaign/examples/CampaignTemplateSourceOwner.yaml @@ -37,5 +37,6 @@ value: emailNotificationEnabled: true autoRevokeAllowed: false recommendationsEnabled: false + correlatedStatus: CORRELATED diff --git a/static/api-specs/idn/beta/schemas/campaign/examples/CampaignTemplates.yaml b/static/api-specs/idn/beta/schemas/campaign/examples/CampaignTemplates.yaml index 952859a0b..bb0e69889 100644 --- a/static/api-specs/idn/beta/schemas/campaign/examples/CampaignTemplates.yaml +++ b/static/api-specs/idn/beta/schemas/campaign/examples/CampaignTemplates.yaml @@ -157,4 +157,5 @@ status: null emailNotificationEnabled: true autoRevokeAllowed: false - recommendationsEnabled: false \ No newline at end of file + recommendationsEnabled: false + correlatedStatus: CORRELATED \ No newline at end of file diff --git a/static/api-specs/idn/beta/schemas/campaign/examples/CreateCampaignSourceOwner.yaml b/static/api-specs/idn/beta/schemas/campaign/examples/CreateCampaignSourceOwner.yaml index 06c034c97..43f400512 100644 --- a/static/api-specs/idn/beta/schemas/campaign/examples/CreateCampaignSourceOwner.yaml +++ b/static/api-specs/idn/beta/schemas/campaign/examples/CreateCampaignSourceOwner.yaml @@ -12,4 +12,5 @@ value: sourceOwnerCampaignInfo: sourceIds: - 612b31b1a0f04aaf83123bdb80e70db6 + correlatedStatus: CORRELATED diff --git a/static/api-specs/idn/beta/schemas/campaign/examples/CreateCampaignTemplateSourceOwner.yaml b/static/api-specs/idn/beta/schemas/campaign/examples/CreateCampaignTemplateSourceOwner.yaml index 2b0ead03a..9932065fd 100644 --- a/static/api-specs/idn/beta/schemas/campaign/examples/CreateCampaignTemplateSourceOwner.yaml +++ b/static/api-specs/idn/beta/schemas/campaign/examples/CreateCampaignTemplateSourceOwner.yaml @@ -17,4 +17,5 @@ value: - 2c918084707deba501709d45ce4e5569 emailNotificationEnabled: true autoRevokeAllowed: false - recommendationsEnabled: false \ No newline at end of file + recommendationsEnabled: false + correlatedStatus: CORRELATED \ No newline at end of file diff --git a/static/api-specs/idn/beta/schemas/campaign/examples/FullCampaignSourceOwner.yaml b/static/api-specs/idn/beta/schemas/campaign/examples/FullCampaignSourceOwner.yaml index 60098dbae..aefe3b02c 100644 --- a/static/api-specs/idn/beta/schemas/campaign/examples/FullCampaignSourceOwner.yaml +++ b/static/api-specs/idn/beta/schemas/campaign/examples/FullCampaignSourceOwner.yaml @@ -24,4 +24,5 @@ value: totalCertifications: 0 completedCertifications: 0 sourcesWithOrphanEntitlements: null + correlatedStatus: CORRELATED \ No newline at end of file diff --git a/static/api-specs/idn/beta/schemas/campaign/examples/FullCampaigns.yaml b/static/api-specs/idn/beta/schemas/campaign/examples/FullCampaigns.yaml index 20971ada1..79726104f 100644 --- a/static/api-specs/idn/beta/schemas/campaign/examples/FullCampaigns.yaml +++ b/static/api-specs/idn/beta/schemas/campaign/examples/FullCampaigns.yaml @@ -117,4 +117,5 @@ value: alerts: null totalCertifications: 2 completedCertifications: 0 - sourcesWithOrphanEntitlements: [] \ No newline at end of file + sourcesWithOrphanEntitlements: [] + correlatedStatus: CORRELATED \ No newline at end of file diff --git a/static/api-specs/idn/beta/schemas/campaign/examples/SlimCampaignSourceOwner.yaml b/static/api-specs/idn/beta/schemas/campaign/examples/SlimCampaignSourceOwner.yaml index 7d7a46cd7..4e033a7ca 100644 --- a/static/api-specs/idn/beta/schemas/campaign/examples/SlimCampaignSourceOwner.yaml +++ b/static/api-specs/idn/beta/schemas/campaign/examples/SlimCampaignSourceOwner.yaml @@ -7,4 +7,5 @@ value: status: STAGED emailNotificationEnabled: true autoRevokeAllowed: false - recommendationsEnabled: false \ No newline at end of file + recommendationsEnabled: false + correlatedStatus: CORRELATED \ No newline at end of file diff --git a/static/api-specs/idn/beta/schemas/campaign/examples/SlimCampaigns.yaml b/static/api-specs/idn/beta/schemas/campaign/examples/SlimCampaigns.yaml index b9759a7f8..4449c1627 100644 --- a/static/api-specs/idn/beta/schemas/campaign/examples/SlimCampaigns.yaml +++ b/static/api-specs/idn/beta/schemas/campaign/examples/SlimCampaigns.yaml @@ -27,6 +27,7 @@ value: emailNotificationEnabled: true autoRevokeAllowed: false recommendationsEnabled: false + correlatedStatus: CORRELATED - id: 3b2e2e5821e84127b6d693d41c40623b name: Role Composition Campaign description: A review done by a role owner.