From deb80a8d247de357f20203165bafaaed7872d5e5 Mon Sep 17 00:00:00 2001 From: GitHub Action Bot Date: Wed, 30 Aug 2023 05:30:32 +0000 Subject: [PATCH] Automated commit 'IDNWAIMEA-11766: campaign delete v3 api spec (#1392)' by github action: 6020953654 --- idn/beta/paths/campaigns-delete.yaml | 5 ++-- idn/sailpoint-api.v3.yaml | 2 ++ idn/v3/paths/campaigns-delete.yaml | 33 ++++++++++++++++++++++ idn/v3/schemas/CampaignsDeleteRequest.yaml | 9 ++++++ 4 files changed, 47 insertions(+), 2 deletions(-) create mode 100644 idn/v3/paths/campaigns-delete.yaml create mode 100644 idn/v3/schemas/CampaignsDeleteRequest.yaml diff --git a/idn/beta/paths/campaigns-delete.yaml b/idn/beta/paths/campaigns-delete.yaml index 1759a583..d912b92a 100644 --- a/idn/beta/paths/campaigns-delete.yaml +++ b/idn/beta/paths/campaigns-delete.yaml @@ -6,8 +6,9 @@ post: description: >- Deletes campaigns whose Ids are specified in the provided list of campaign Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. -# security: -# - oauth2: [CERT_ADMIN,ORG_ADMIN] + deprecated: true + security: + - oauth2: [idn:campaign:delete] requestBody: description: The ids of the campaigns to delete. required: true diff --git a/idn/sailpoint-api.v3.yaml b/idn/sailpoint-api.v3.yaml index ef153245..78fc9998 100644 --- a/idn/sailpoint-api.v3.yaml +++ b/idn/sailpoint-api.v3.yaml @@ -824,6 +824,8 @@ paths: $ref: './v3/paths/campaign-activate.yaml' /campaigns/{id}/complete: $ref: './v3/paths/campaign-complete.yaml' + /campaigns/delete: + $ref: './v3/paths/campaigns-delete.yaml' /certifications: $ref: "./v3/paths/identity-certifications.yaml" /certifications/{id}: diff --git a/idn/v3/paths/campaigns-delete.yaml b/idn/v3/paths/campaigns-delete.yaml new file mode 100644 index 00000000..80c40ffe --- /dev/null +++ b/idn/v3/paths/campaigns-delete.yaml @@ -0,0 +1,33 @@ +post: + operationId: deleteCampaigns + tags: + - Certification Campaigns + summary: Deletes Campaigns + description: >- + Deletes campaigns whose Ids are specified in the provided list of campaign Ids. + Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. + security: + - oauth2: [idn:campaign:delete] + requestBody: + description: The ids of the campaigns to delete. + required: true + content: + application/json: + schema: + $ref: '../schemas/CampaignsDeleteRequest.yaml' + + responses: + '202': + $ref: '../responses/202.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/idn/v3/schemas/CampaignsDeleteRequest.yaml b/idn/v3/schemas/CampaignsDeleteRequest.yaml new file mode 100644 index 00000000..2df36fff --- /dev/null +++ b/idn/v3/schemas/CampaignsDeleteRequest.yaml @@ -0,0 +1,9 @@ +type : object +properties: + ids: + description: The ids of the campaigns to delete + type: array + items: + type: string + example: + ["2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021"] \ No newline at end of file