From db1daf6cad95114f8cb1f07b8c1b032f571ef8f9 Mon Sep 17 00:00:00 2001 From: GitHub Action Bot Date: Tue, 28 Nov 2023 19:24:05 +0000 Subject: [PATCH] Automated commit by github action: 7023530373 --- .../api-specs/idn/beta/paths/campaigns.yaml | 2 +- .../idn/beta/paths/mfa-kba-authenticate.yaml | 59 +++++++++++++++++++ static/api-specs/idn/beta/paths/mfa-poll.yaml | 54 +++++++++++++++++ .../beta/paths/mfa-token-authenticate.yaml | 43 ++++++++++++++ .../idn/beta/paths/mfa-token-send.yaml | 44 ++++++++++++++ .../api-specs/idn/beta/schemas/Campaign.yaml | 24 +------- .../idn/beta/schemas/KbaAnswerRequest.yaml | 18 ++++++ .../beta/schemas/KbaAnswerRequestItem.yaml | 15 +++++ .../idn/beta/schemas/KbaAuthResponse.yaml | 19 ++++++ .../idn/beta/schemas/KbaAuthResponseItem.yaml | 13 ++++ .../idn/beta/schemas/SendTokenRequest.yaml | 24 ++++++++ .../idn/beta/schemas/SendTokenResponse.yaml | 19 ++++++ .../idn/beta/schemas/SlimCampaign.yaml | 26 +++++++- .../idn/beta/schemas/TokenAuthRequest.yaml | 28 +++++++++ .../idn/beta/schemas/TokenAuthResponse.yaml | 12 ++++ .../beta/schemas/VerificationPollRequest.yaml | 9 +++ .../beta/schemas/VerificationResponse.yaml | 22 +++++++ .../campaign/examples/FullCampaigns.yaml | 23 +------- .../campaign/examples/SlimCampaigns.yaml | 28 ++++++++- static/api-specs/idn/sailpoint-api.beta.yaml | 10 ++++ static/api-specs/idn/v3/paths/campaigns.yaml | 2 +- static/api-specs/idn/v3/schemas/Campaign.yaml | 22 ------- .../idn/v3/schemas/SlimCampaign.yaml | 26 +++++++- .../campaign/examples/FullCampaigns.yaml | 23 +------- .../campaign/examples/SlimCampaigns.yaml | 28 ++++++++- 25 files changed, 498 insertions(+), 95 deletions(-) create mode 100644 static/api-specs/idn/beta/paths/mfa-kba-authenticate.yaml create mode 100644 static/api-specs/idn/beta/paths/mfa-poll.yaml create mode 100644 static/api-specs/idn/beta/paths/mfa-token-authenticate.yaml create mode 100644 static/api-specs/idn/beta/paths/mfa-token-send.yaml create mode 100644 static/api-specs/idn/beta/schemas/KbaAnswerRequest.yaml create mode 100644 static/api-specs/idn/beta/schemas/KbaAnswerRequestItem.yaml create mode 100644 static/api-specs/idn/beta/schemas/KbaAuthResponse.yaml create mode 100644 static/api-specs/idn/beta/schemas/KbaAuthResponseItem.yaml create mode 100644 static/api-specs/idn/beta/schemas/SendTokenRequest.yaml create mode 100644 static/api-specs/idn/beta/schemas/SendTokenResponse.yaml create mode 100644 static/api-specs/idn/beta/schemas/TokenAuthRequest.yaml create mode 100644 static/api-specs/idn/beta/schemas/TokenAuthResponse.yaml create mode 100644 static/api-specs/idn/beta/schemas/VerificationPollRequest.yaml create mode 100644 static/api-specs/idn/beta/schemas/VerificationResponse.yaml diff --git a/static/api-specs/idn/beta/paths/campaigns.yaml b/static/api-specs/idn/beta/paths/campaigns.yaml index 78738611a6f..34698b7cbfe 100644 --- a/static/api-specs/idn/beta/paths/campaigns.yaml +++ b/static/api-specs/idn/beta/paths/campaigns.yaml @@ -57,7 +57,7 @@ get: example: name responses: '200': - description: A list of campaign objects. + description: A list of campaign objects. By default list of SLIM campaigns is returned. content: application/json: schema: diff --git a/static/api-specs/idn/beta/paths/mfa-kba-authenticate.yaml b/static/api-specs/idn/beta/paths/mfa-kba-authenticate.yaml new file mode 100644 index 00000000000..2f83d59db03 --- /dev/null +++ b/static/api-specs/idn/beta/paths/mfa-kba-authenticate.yaml @@ -0,0 +1,59 @@ +post: + operationId: sendKbaAnswers + tags: + - MFA Controller + summary: Authenticate KBA provided MFA method + description: >- + This API Authenticate user in KBA MFA method. + security: + - UserContextAuth: [idn:mfa-kba:authenticate] + requestBody: + required: true + content: + application/json: + schema: + $ref: "../schemas/KbaAnswerRequest.yaml" + example: + {"answers": [ + { + "questionId": "089899f13a8f4da7824996191587bab9", + "answer": "Your answer" + }, + { + "questionId": "067899f13a8f4da7824996191587bab9", + "answer": "Your answer1" + } + ] + } + + responses: + "200": + description: KBA authenticated status. + content: + application/json: + schema: + $ref: "../schemas/KbaAuthResponse.yaml" + example: + { + "kbaAuthResponseItem": [ + { + "questionId": "089899f13a8f4da7824996191587bab9", + "IsVerified": false + }, + { + "questionId": "089899f13a8f4da7824996191587bda8", + "IsVerified": true + } + ], + "status": "PENDING" + } + "400": + $ref: "../../v3/responses/400.yaml" + "401": + $ref: "../../v3/responses/401.yaml" + "403": + $ref: "../../v3/responses/403.yaml" + "429": + $ref: "../../v3/responses/429.yaml" + "500": + $ref: "../../v3/responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/idn/beta/paths/mfa-poll.yaml b/static/api-specs/idn/beta/paths/mfa-poll.yaml new file mode 100644 index 00000000000..93455bc02e4 --- /dev/null +++ b/static/api-specs/idn/beta/paths/mfa-poll.yaml @@ -0,0 +1,54 @@ +post: + operationId: pingVerificationStatus + tags: + - MFA Controller + summary: Polling MFA method by VerificationPollRequest + description: >- + This API poll the VerificationPollRequest for the specified MFA method. + A token with ORG_ADMIN authority is required to call this API. + security: + - UserContextAuth: [idn:mfa:poll] + parameters: + - in: path + name: method + schema: + type: string + example: okta-verify + required: true + description: >- + The name of the MFA method. + The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' + requestBody: + required: true + content: + application/json: + schema: + $ref: "../schemas/VerificationPollRequest.yaml" + example: + { + "requestId": "089899f13a8f4da7824996191587bab9" + } + + responses: + "200": + description: MFA VerificationPollRequest status an MFA method. + content: + application/json: + schema: + $ref: "../schemas/VerificationResponse.yaml" + example: + { + "requestId": "089899f13a8f4da7824996191587bab9", + "status": "PENDING", + "error" : "" + } + "400": + $ref: "../../v3/responses/400.yaml" + "401": + $ref: "../../v3/responses/401.yaml" + "403": + $ref: "../../v3/responses/403.yaml" + "429": + $ref: "../../v3/responses/429.yaml" + "500": + $ref: "../../v3/responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/idn/beta/paths/mfa-token-authenticate.yaml b/static/api-specs/idn/beta/paths/mfa-token-authenticate.yaml new file mode 100644 index 00000000000..e75921e56a7 --- /dev/null +++ b/static/api-specs/idn/beta/paths/mfa-token-authenticate.yaml @@ -0,0 +1,43 @@ +post: + operationId: sendTokenAuthRequest + tags: + - MFA Controller + summary: Authenticate Token provided MFA method + description: >- + This API Authenticate user in Token MFA method. + security: + - UserContextAuth: [idn:mfa:verify] + requestBody: + required: true + content: + application/json: + schema: + $ref: "../schemas/TokenAuthRequest.yaml" + example: + { + "token": "12345", + "userAlias": "will.albin", + "deliveryType": "EMAIL_WORK" + } + + responses: + "200": + description: Token authenticated status. + content: + application/json: + schema: + $ref: "../schemas/TokenAuthResponse.yaml" + example: + { + "status": "PENDING" + } + "400": + $ref: "../../v3/responses/400.yaml" + "401": + $ref: "../../v3/responses/401.yaml" + "403": + $ref: "../../v3/responses/403.yaml" + "429": + $ref: "../../v3/responses/429.yaml" + "500": + $ref: "../../v3/responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/idn/beta/paths/mfa-token-send.yaml b/static/api-specs/idn/beta/paths/mfa-token-send.yaml new file mode 100644 index 00000000000..b9897212024 --- /dev/null +++ b/static/api-specs/idn/beta/paths/mfa-token-send.yaml @@ -0,0 +1,44 @@ +post: + operationId: createSendToken + tags: + - MFA Controller + summary: Create and send user token + description: + This API send token request. + security: + - UserContextAuth: [idn:mfa:send] + requestBody: + required: true + content: + application/json: + schema: + $ref: "../schemas/SendTokenRequest.yaml" + example: + { + "userAlias": "will.albin", + "deliveryType": "EMAIL_WORK" + } + + responses: + "200": + description: Token send status. + content: + application/json: + schema: + $ref: "../schemas/SendTokenResponse.yaml" + example: + { + "requestId": "089899f13a8f4da7824996191587bab9", + "status": "SUCCESS", + "errorMessage": "" + } + "400": + $ref: "../../v3/responses/400.yaml" + "401": + $ref: "../../v3/responses/401.yaml" + "403": + $ref: "../../v3/responses/403.yaml" + "429": + $ref: "../../v3/responses/429.yaml" + "500": + $ref: "../../v3/responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/idn/beta/schemas/Campaign.yaml b/static/api-specs/idn/beta/schemas/Campaign.yaml index b9b5f47ec2c..550b2704c52 100644 --- a/static/api-specs/idn/beta/schemas/Campaign.yaml +++ b/static/api-specs/idn/beta/schemas/Campaign.yaml @@ -4,12 +4,6 @@ allOf: - $ref: 'SlimCampaign.yaml' - type: object properties: - created: - type: string - readOnly: true - format: date-time - description: Created time of the campaign - example: '2020-03-03T22:15:13.611Z' modified: type: string readOnly: true @@ -194,22 +188,6 @@ allOf: example: Role Composition Description required: - remediatorRef - alerts: - type: array - description: A list of errors and warnings that have accumulated. - readOnly: true - items: - $ref: './CampaignAlert.yaml' - totalCertifications: - type: integer - description: The total number of certifications in this campaign. - readOnly: true - example: 100 - completedCertifications: - type: integer - description: The number of completed certifications in this campaign. - readOnly: true - example: 10 sourcesWithOrphanEntitlements: type: array description: >- @@ -243,4 +221,4 @@ allOf: - "ALL_DECISIONS" - "REVOKE_ONLY_DECISIONS" - "NO_DECISIONS" - example: NO_DECISIONS \ No newline at end of file + example: NO_DECISIONS diff --git a/static/api-specs/idn/beta/schemas/KbaAnswerRequest.yaml b/static/api-specs/idn/beta/schemas/KbaAnswerRequest.yaml new file mode 100644 index 00000000000..38d02f15c6a --- /dev/null +++ b/static/api-specs/idn/beta/schemas/KbaAnswerRequest.yaml @@ -0,0 +1,18 @@ +type: object +properties: + answers: + nullable: false + type: array + items: + $ref: "../schemas/KbaAnswerRequestItem.yaml" + + description: Kba answers + example: + - questionId: 089899f13a8f4da7824996191587bab9 + answer: Your answer + - questionId: 067899f13a8f4da7824996191587bab9 + answer: Your answer1 +required: + - answers + + diff --git a/static/api-specs/idn/beta/schemas/KbaAnswerRequestItem.yaml b/static/api-specs/idn/beta/schemas/KbaAnswerRequestItem.yaml new file mode 100644 index 00000000000..37d6b9808f3 --- /dev/null +++ b/static/api-specs/idn/beta/schemas/KbaAnswerRequestItem.yaml @@ -0,0 +1,15 @@ +type: object +properties: + questionId: + type: string + nullable: false + description: Question Id + example: 089899f13a8f4da7824996191587bab9 + answer: + type: string + nullable: false + description: An answer for the KBA question + example: Your answer +required: + - questionId + - answer \ No newline at end of file diff --git a/static/api-specs/idn/beta/schemas/KbaAuthResponse.yaml b/static/api-specs/idn/beta/schemas/KbaAuthResponse.yaml new file mode 100644 index 00000000000..95ac3322969 --- /dev/null +++ b/static/api-specs/idn/beta/schemas/KbaAuthResponse.yaml @@ -0,0 +1,19 @@ +type: object +properties: + kbaAuthResponseItems: + type: array + example: + - questionId: 089899f13a8f4da7824996191587bab9 + isVerified: false + items: + $ref: '../schemas/KbaAuthResponseItem.yaml' + status: + type: string + enum: + - PENDING + - SUCCESS + - FAILED + - LOCKOUT + - NOT_ENOUGH_DATA + description: MFA Authentication status + example: PENDING \ No newline at end of file diff --git a/static/api-specs/idn/beta/schemas/KbaAuthResponseItem.yaml b/static/api-specs/idn/beta/schemas/KbaAuthResponseItem.yaml new file mode 100644 index 00000000000..5090787d290 --- /dev/null +++ b/static/api-specs/idn/beta/schemas/KbaAuthResponseItem.yaml @@ -0,0 +1,13 @@ +type: object +properties: + questionId: + type: string + nullable: true + description: The KBA question id + example: 089899f13a8f4da7824996191587bab9 + isVerified: + type: boolean + nullable: true + default: null + description: Return true if verified + example: true \ No newline at end of file diff --git a/static/api-specs/idn/beta/schemas/SendTokenRequest.yaml b/static/api-specs/idn/beta/schemas/SendTokenRequest.yaml new file mode 100644 index 00000000000..f2c2a832893 --- /dev/null +++ b/static/api-specs/idn/beta/schemas/SendTokenRequest.yaml @@ -0,0 +1,24 @@ +type: object +properties: + userAlias: + nullable: false + type: string + description: User alias from table spt_identity field named 'name' + example: will.albin + deliveryType: + nullable: false + type: string + enum: + - SMS_PERSONAL #("sms", "phone") + - VOICE_PERSONAL #("voice", "phone") + - SMS_WORK #("sms", "work") + - VOICE_WORK #("voice","work") + - EMAIL_WORK #("email"L, "email") + - EMAIL_PERSONAL #("email", "personalEmail") + description: Token delivery type + example: "EMAIL_WORK" +required: + - userAlias + - deliveryType + + diff --git a/static/api-specs/idn/beta/schemas/SendTokenResponse.yaml b/static/api-specs/idn/beta/schemas/SendTokenResponse.yaml new file mode 100644 index 00000000000..c1fc36696f6 --- /dev/null +++ b/static/api-specs/idn/beta/schemas/SendTokenResponse.yaml @@ -0,0 +1,19 @@ +type: object +properties: + requestId: + type: string + nullable: true + description: The token request ID + example: 089899f13a8f4da7824996191587bab9 + status: + type: string + enum: + - SUCCESS + - FAILED + description: Status of sending token + example: SUCCESS + errorMessage: + type: string + nullable: true + description: Error messages from token send request + example: Unable to sent text message \ No newline at end of file diff --git a/static/api-specs/idn/beta/schemas/SlimCampaign.yaml b/static/api-specs/idn/beta/schemas/SlimCampaign.yaml index 0089e3ff7ae..d97a0fe4057 100644 --- a/static/api-specs/idn/beta/schemas/SlimCampaign.yaml +++ b/static/api-specs/idn/beta/schemas/SlimCampaign.yaml @@ -77,4 +77,28 @@ properties: enum: - CORRELATED - UNCORRELATED - example: CORRELATED \ No newline at end of file + example: CORRELATED + created: + type: string + readOnly: true + format: date-time + description: Created time of the campaign + example: '2020-03-03T22:15:13.611Z' + totalCertifications: + type: integer + format: int32 + description: The total number of certifications in this campaign. + readOnly: true + example: 100 + completedCertifications: + type: integer + format: int32 + description: The number of completed certifications in this campaign. + readOnly: true + example: 10 + alerts: + type: array + description: A list of errors and warnings that have accumulated. + readOnly: true + items: + $ref: './CampaignAlert.yaml' diff --git a/static/api-specs/idn/beta/schemas/TokenAuthRequest.yaml b/static/api-specs/idn/beta/schemas/TokenAuthRequest.yaml new file mode 100644 index 00000000000..ed384cb0d9c --- /dev/null +++ b/static/api-specs/idn/beta/schemas/TokenAuthRequest.yaml @@ -0,0 +1,28 @@ +type: object +properties: + token: + nullable: false + type: string + description: Token value + example: "12345" + userAlias: + nullable: false + type: string + description: User alias from table spt_identity field named 'name' + example: "will.albin" + deliveryType: + nullable: false + type: string + enum: + - SMS_PERSONAL #("sms", "phone") + - VOICE_PERSONAL #("voice", "phone") + - SMS_WORK #("sms", "work") + - VOICE_WORK #("voice","work") + - EMAIL_WORK #("email"L, "email") + - EMAIL_PERSONAL #("email", "personalEmail") + description: Token delivery type + example: "EMAIL_WORK" +required: + - token + - userAlias + - deliveryType \ No newline at end of file diff --git a/static/api-specs/idn/beta/schemas/TokenAuthResponse.yaml b/static/api-specs/idn/beta/schemas/TokenAuthResponse.yaml new file mode 100644 index 00000000000..7e63f6d8dd0 --- /dev/null +++ b/static/api-specs/idn/beta/schemas/TokenAuthResponse.yaml @@ -0,0 +1,12 @@ +type: object +properties: + status: + type: string + enum: + - PENDING + - SUCCESS + - FAILED + - LOCKOUT + - NOT_ENOUGH_DATA + description: MFA Authentication status + example: PENDING \ No newline at end of file diff --git a/static/api-specs/idn/beta/schemas/VerificationPollRequest.yaml b/static/api-specs/idn/beta/schemas/VerificationPollRequest.yaml new file mode 100644 index 00000000000..0c6c4a15b8f --- /dev/null +++ b/static/api-specs/idn/beta/schemas/VerificationPollRequest.yaml @@ -0,0 +1,9 @@ +type: object +properties: + requestId: + type: string + nullable: false + description: Verification request Id + example: 089899f13a8f4da7824996191587bab9 +required: + - requestId diff --git a/static/api-specs/idn/beta/schemas/VerificationResponse.yaml b/static/api-specs/idn/beta/schemas/VerificationResponse.yaml new file mode 100644 index 00000000000..d5045a4c5ef --- /dev/null +++ b/static/api-specs/idn/beta/schemas/VerificationResponse.yaml @@ -0,0 +1,22 @@ +type: object +properties: + requestId: + type: string + nullable: true + description: The verificationPollRequest request ID + example: 089899f13a8f4da7824996191587bab9 + status: + type: string + enum: + - PENDING + - SUCCESS + - FAILED + - LOCKOUT + - NOT_ENOUGH_DATA + description: MFA Authentication status + example: SUCCESS + error: + type: string + nullable: true + description: Error messages from MFA verification request + example: Unable to connect DUO Service during verification \ 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 6732259e7dc..cd26ad01d08 100644 --- a/static/api-specs/idn/beta/schemas/campaign/examples/FullCampaigns.yaml +++ b/static/api-specs/idn/beta/schemas/campaign/examples/FullCampaigns.yaml @@ -9,7 +9,6 @@ value: emailNotificationEnabled: false autoRevokeAllowed: false recommendationsEnabled: false - created: 2022-08-02T20:29:51.065Z modified: 2022-08-02T20:29:51.331Z filter: type: CAMPAIGN_FILTER @@ -29,14 +28,6 @@ value: - b15d609fc5c8434b865fe552315fda8f query: null description: null - alerts: - - level: ERROR - localizations: - - locale: en - localeOrigin: DEFAULT - text: Composite criterion must have children non-composite criterion must not. - totalCertifications: 0 - completedCertifications: 0 sourcesWithOrphanEntitlements: null mandatoryCommentRequirement: NO_DECISIONS - id: 1be8fc1103914bf0a4e14e316b6a7b7c @@ -48,7 +39,6 @@ value: emailNotificationEnabled: false autoRevokeAllowed: false recommendationsEnabled: false - created: 2022-08-02T19:00:27.731Z modified: 2022-08-02T19:00:34.391Z filter: type: CAMPAIGN_FILTER @@ -58,9 +48,6 @@ value: sourceOwnerCampaignInfo: null searchCampaignInfo: null roleCompositionCampaignInfo: null - alerts: null - totalCertifications: 5 - completedCertifications: 0 sourcesWithOrphanEntitlements: [] mandatoryCommentRequirement: NO_DECISIONS - id: 7e1a731e3fb845cfbe58112ba4673ee4 @@ -72,7 +59,6 @@ value: emailNotificationEnabled: false autoRevokeAllowed: false recommendationsEnabled: false - created: 2022-07-25T15:42:18.276Z modified: 2022-07-25T15:42:53.718Z filter: type: CAMPAIGN_FILTER @@ -91,9 +77,6 @@ value: identityIds: null accessConstraints: [] roleCompositionCampaignInfo: null - alerts: null - totalCertifications: 6 - completedCertifications: 0 sourcesWithOrphanEntitlements: [] mandatoryCommentRequirement: NO_DECISIONS - id: ad3cf3dd50394b1bad646de4bc51b999 @@ -105,7 +88,6 @@ value: emailNotificationEnabled: true autoRevokeAllowed: false recommendationsEnabled: false - created: 2022-07-27T17:04:19.027Z modified: 2022-07-27T17:09:13.925Z filter: type: CAMPAIGN_FILTER @@ -117,9 +99,6 @@ value: - 2c91808781fd5aea01821200dc88318e searchCampaignInfo: null roleCompositionCampaignInfo: null - alerts: null - totalCertifications: 2 - completedCertifications: 0 sourcesWithOrphanEntitlements: [] correlatedStatus: CORRELATED - mandatoryCommentRequirement: NO_DECISIONS \ No newline at end of file + mandatoryCommentRequirement: NO_DECISIONS 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 4449c162722..cf84e2a1e19 100644 --- a/static/api-specs/idn/beta/schemas/campaign/examples/SlimCampaigns.yaml +++ b/static/api-specs/idn/beta/schemas/campaign/examples/SlimCampaigns.yaml @@ -9,6 +9,15 @@ value: emailNotificationEnabled: false autoRevokeAllowed: false recommendationsEnabled: false + created: 2022-08-02T20:29:51.065Z + totalCertifications: 10 + completedCertifications: 3 + alerts: + - level: ERROR + localizations: + - locale: en + localeOrigin: DEFAULT + text: Composite criterion must have children non-composite criterion must not. - id: 7e1a731e3fb845cfbe58112ba4673ee4 name: Search Campaign description: Search Campaign Info @@ -18,6 +27,10 @@ value: emailNotificationEnabled: false autoRevokeAllowed: false recommendationsEnabled: false + created: 2022-08-02T19:00:27.731Z + totalCertifications: 5 + completedCertifications: 3 + alerts: null - id: 2c918086719eec070171a7e3355a412b name: AD Source Review description: A review of our AD source. @@ -27,6 +40,15 @@ value: emailNotificationEnabled: true autoRevokeAllowed: false recommendationsEnabled: false + created: 2022-07-25T15:42:18.276Z + totalCertifications: 7 + completedCertifications: 3 + alerts: + - level: WARN + localizations: + - locale: en + localeOrigin: DEFAULT + text: Composite criterion is in wrong format. correlatedStatus: CORRELATED - id: 3b2e2e5821e84127b6d693d41c40623b name: Role Composition Campaign @@ -36,4 +58,8 @@ value: status: ACTIVE emailNotificationEnabled: false autoRevokeAllowed: false - recommendationsEnabled: false \ No newline at end of file + recommendationsEnabled: false + created: 2022-07-27T17:04:19.027Z + totalCertifications: 1 + completedCertifications: 1 + alerts: null diff --git a/static/api-specs/idn/sailpoint-api.beta.yaml b/static/api-specs/idn/sailpoint-api.beta.yaml index 8854474613a..303344dd59c 100644 --- a/static/api-specs/idn/sailpoint-api.beta.yaml +++ b/static/api-specs/idn/sailpoint-api.beta.yaml @@ -439,6 +439,8 @@ tags: description: Operations for accessing and managing client Clusters, including Log Configuration - name: MFA Configuration description: Configure and test multifactor authentication (MFA) methods + - name: MFA Controller + description: This API used for multifactor authentication functionality belong to gov-multi-auth service. This controller allow you to verify authentication by specified method - name: Non-Employee Lifecycle Management description: | Use this API to implement non-employee lifecycle management functionality. @@ -1254,6 +1256,14 @@ paths: $ref: './beta/paths/mfa-config-test.yaml' /mfa/{method}/delete: $ref: './beta/paths/mfa-config-delete.yaml' + /mfa/{method}/poll: + $ref: './beta/paths/mfa-poll.yaml' + /mfa/kba/authenticate: + $ref: './beta/paths/mfa-kba-authenticate.yaml' + /mfa/token/authenticate: + $ref: './beta/paths/mfa-token-authenticate.yaml' + /mfa/token/send: + $ref: './beta/paths/mfa-token-send.yaml' /notification-template-defaults: $ref: './beta/paths/notification-template-defaults.yaml' /notification-templates: diff --git a/static/api-specs/idn/v3/paths/campaigns.yaml b/static/api-specs/idn/v3/paths/campaigns.yaml index 974c365fa3e..5f7c62debe5 100644 --- a/static/api-specs/idn/v3/paths/campaigns.yaml +++ b/static/api-specs/idn/v3/paths/campaigns.yaml @@ -56,7 +56,7 @@ get: example: name responses: '200': - description: A list of campaign objects. + description: A list of campaign objects. By default list of SLIM campaigns is returned. content: application/json: schema: diff --git a/static/api-specs/idn/v3/schemas/Campaign.yaml b/static/api-specs/idn/v3/schemas/Campaign.yaml index 5d6bba7ef41..550b2704c52 100644 --- a/static/api-specs/idn/v3/schemas/Campaign.yaml +++ b/static/api-specs/idn/v3/schemas/Campaign.yaml @@ -4,12 +4,6 @@ allOf: - $ref: 'SlimCampaign.yaml' - type: object properties: - created: - type: string - readOnly: true - format: date-time - description: Created time of the campaign - example: '2020-03-03T22:15:13.611Z' modified: type: string readOnly: true @@ -194,22 +188,6 @@ allOf: example: Role Composition Description required: - remediatorRef - alerts: - type: array - description: A list of errors and warnings that have accumulated. - readOnly: true - items: - $ref: './CampaignAlert.yaml' - totalCertifications: - type: integer - description: The total number of certifications in this campaign. - readOnly: true - example: 100 - completedCertifications: - type: integer - description: The number of completed certifications in this campaign. - readOnly: true - example: 10 sourcesWithOrphanEntitlements: type: array description: >- diff --git a/static/api-specs/idn/v3/schemas/SlimCampaign.yaml b/static/api-specs/idn/v3/schemas/SlimCampaign.yaml index 0089e3ff7ae..d97a0fe4057 100644 --- a/static/api-specs/idn/v3/schemas/SlimCampaign.yaml +++ b/static/api-specs/idn/v3/schemas/SlimCampaign.yaml @@ -77,4 +77,28 @@ properties: enum: - CORRELATED - UNCORRELATED - example: CORRELATED \ No newline at end of file + example: CORRELATED + created: + type: string + readOnly: true + format: date-time + description: Created time of the campaign + example: '2020-03-03T22:15:13.611Z' + totalCertifications: + type: integer + format: int32 + description: The total number of certifications in this campaign. + readOnly: true + example: 100 + completedCertifications: + type: integer + format: int32 + description: The number of completed certifications in this campaign. + readOnly: true + example: 10 + alerts: + type: array + description: A list of errors and warnings that have accumulated. + readOnly: true + items: + $ref: './CampaignAlert.yaml' diff --git a/static/api-specs/idn/v3/schemas/campaign/examples/FullCampaigns.yaml b/static/api-specs/idn/v3/schemas/campaign/examples/FullCampaigns.yaml index 6732259e7dc..cd26ad01d08 100644 --- a/static/api-specs/idn/v3/schemas/campaign/examples/FullCampaigns.yaml +++ b/static/api-specs/idn/v3/schemas/campaign/examples/FullCampaigns.yaml @@ -9,7 +9,6 @@ value: emailNotificationEnabled: false autoRevokeAllowed: false recommendationsEnabled: false - created: 2022-08-02T20:29:51.065Z modified: 2022-08-02T20:29:51.331Z filter: type: CAMPAIGN_FILTER @@ -29,14 +28,6 @@ value: - b15d609fc5c8434b865fe552315fda8f query: null description: null - alerts: - - level: ERROR - localizations: - - locale: en - localeOrigin: DEFAULT - text: Composite criterion must have children non-composite criterion must not. - totalCertifications: 0 - completedCertifications: 0 sourcesWithOrphanEntitlements: null mandatoryCommentRequirement: NO_DECISIONS - id: 1be8fc1103914bf0a4e14e316b6a7b7c @@ -48,7 +39,6 @@ value: emailNotificationEnabled: false autoRevokeAllowed: false recommendationsEnabled: false - created: 2022-08-02T19:00:27.731Z modified: 2022-08-02T19:00:34.391Z filter: type: CAMPAIGN_FILTER @@ -58,9 +48,6 @@ value: sourceOwnerCampaignInfo: null searchCampaignInfo: null roleCompositionCampaignInfo: null - alerts: null - totalCertifications: 5 - completedCertifications: 0 sourcesWithOrphanEntitlements: [] mandatoryCommentRequirement: NO_DECISIONS - id: 7e1a731e3fb845cfbe58112ba4673ee4 @@ -72,7 +59,6 @@ value: emailNotificationEnabled: false autoRevokeAllowed: false recommendationsEnabled: false - created: 2022-07-25T15:42:18.276Z modified: 2022-07-25T15:42:53.718Z filter: type: CAMPAIGN_FILTER @@ -91,9 +77,6 @@ value: identityIds: null accessConstraints: [] roleCompositionCampaignInfo: null - alerts: null - totalCertifications: 6 - completedCertifications: 0 sourcesWithOrphanEntitlements: [] mandatoryCommentRequirement: NO_DECISIONS - id: ad3cf3dd50394b1bad646de4bc51b999 @@ -105,7 +88,6 @@ value: emailNotificationEnabled: true autoRevokeAllowed: false recommendationsEnabled: false - created: 2022-07-27T17:04:19.027Z modified: 2022-07-27T17:09:13.925Z filter: type: CAMPAIGN_FILTER @@ -117,9 +99,6 @@ value: - 2c91808781fd5aea01821200dc88318e searchCampaignInfo: null roleCompositionCampaignInfo: null - alerts: null - totalCertifications: 2 - completedCertifications: 0 sourcesWithOrphanEntitlements: [] correlatedStatus: CORRELATED - mandatoryCommentRequirement: NO_DECISIONS \ No newline at end of file + mandatoryCommentRequirement: NO_DECISIONS diff --git a/static/api-specs/idn/v3/schemas/campaign/examples/SlimCampaigns.yaml b/static/api-specs/idn/v3/schemas/campaign/examples/SlimCampaigns.yaml index 4449c162722..3ff178465af 100644 --- a/static/api-specs/idn/v3/schemas/campaign/examples/SlimCampaigns.yaml +++ b/static/api-specs/idn/v3/schemas/campaign/examples/SlimCampaigns.yaml @@ -9,6 +9,15 @@ value: emailNotificationEnabled: false autoRevokeAllowed: false recommendationsEnabled: false + created: 2022-08-02T19:00:27.731Z + totalCertifications: 10 + completedCertifications: 3 + alerts: + - level: ERROR + localizations: + - locale: en + localeOrigin: DEFAULT + text: Composite criterion must have children non-composite criterion must not. - id: 7e1a731e3fb845cfbe58112ba4673ee4 name: Search Campaign description: Search Campaign Info @@ -18,6 +27,10 @@ value: emailNotificationEnabled: false autoRevokeAllowed: false recommendationsEnabled: false + created: 2022-07-25T15:42:18.276Z + totalCertifications: 5 + completedCertifications: 3 + alerts: null - id: 2c918086719eec070171a7e3355a412b name: AD Source Review description: A review of our AD source. @@ -28,6 +41,15 @@ value: autoRevokeAllowed: false recommendationsEnabled: false correlatedStatus: CORRELATED + created: 2022-07-27T17:04:19.027Z + totalCertifications: 7 + completedCertifications: 3 + alerts: + - level: WARN + localizations: + - locale: en + localeOrigin: DEFAULT + text: Composite criterion is in wrong format. - id: 3b2e2e5821e84127b6d693d41c40623b name: Role Composition Campaign description: A review done by a role owner. @@ -36,4 +58,8 @@ value: status: ACTIVE emailNotificationEnabled: false autoRevokeAllowed: false - recommendationsEnabled: false \ No newline at end of file + recommendationsEnabled: false + created: 2022-08-02T20:29:51.065Z + totalCertifications: 1 + completedCertifications: 1 + alerts: null