sdp-api-specification/admin_mfa_settings.yml at main · appgate/sdp-api-specification · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
admin-mfa-settings:
  get:
    summary: View Admin MFA settings.
    description: View Admin MFA settings.
    tags:
      - MFA for Admins
    parameters:
      - $ref: './common.yml#/parameters/authorization'
    responses:
      '200':
        description: Admin MFA settings.
        content:
          application/json:
            schema:
              $ref: '#/definitions/AdminMfaSettings'
      '401':
        $ref: './common.yml#/responses/TokenError'
      '403':
        $ref: './common.yml#/responses/PermissionError'
      '500':
        $ref: './common.yml#/responses/UnexpectedError'
  delete:
    summary: Reset Admin MFA settings to disabled.
    description: Reset Admin MFA settings to disabled.
    tags:
      - MFA for Admins
    parameters:
      - $ref: './common.yml#/parameters/authorization'
    responses:
      '204':
        description: Admin MFA settings were reset successfully.
      '401':
        $ref: './common.yml#/responses/TokenError'
      '403':
        $ref: './common.yml#/responses/PermissionError'
      '500':
        $ref: './common.yml#/responses/UnexpectedError'
  put:
    summary: Update Admin MFA settings.
    description: Update Admin MFA settings.
    tags:
      - MFA for Admins
    parameters:
      - $ref: './common.yml#/parameters/authorization'
    responses:
      '204':
        description: Admin MFA settings were updated successfully.
      '400':
        $ref: './common.yml#/responses/JsonError'
      '401':
        $ref: './common.yml#/responses/TokenError'
      '403':
        $ref: './common.yml#/responses/PermissionError'
      '422':
        $ref: './common.yml#/responses/ValidationError'
      '500':
        $ref: './common.yml#/responses/UnexpectedError'
    requestBody:
      content:
        application/json:
          schema:
            $ref: '#/definitions/AdminMfaSettings'
      description: Admin MFA settings.

definitions:
  AdminMfaSettings:
    type: object
    properties:
      providerId:
        type: string
        format: uuid
        x-uuid-ref: MfaProvider
        description: The MFA provider ID to use during Multi-Factor Authentication. If null, Admin MFA is disabled.
        example: 4c07bc67-57ea-42dd-b702-c2d6c45419fc
      exemptedUsers:
        type: array
        description: List of users to be excluded from MFA during admin login.
        items:
          type: string
          description: User Distinguished Name.
          example: 'CN=user,OU=provider'