bigid/openapi/bigid-dsar-api-openapi.yml at main · api-evangelist/bigid · 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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
openapi: 3.0.3
info:
  title: BigID DSAR API
  description: >-
    Run Data Subject Access Requests (DSARs) and retrieve the resulting reports
    via the BigID API. Inspect available DSAR profiles and identifier attributes,
    submit new DSAR scans, poll status, and download short or full DSAR reports
    in JSON or CSV.
  version: '1.0'
  contact:
    name: BigID Support
    url: https://developer.bigid.com/
    email: support@bigid.com
  license:
    name: BigID Terms of Service
    url: https://bigid.com/terms/
servers:
  - url: https://{deployment}.bigid.com/api/v1
    description: Customer-hosted BigID deployment.
    variables:
      deployment:
        default: tenant
tags:
  - name: DSAR
    description: Data Subject Access Request operations.
paths:
  /sar/profiles:
    get:
      tags:
        - DSAR
      operationId: listDsarProfiles
      summary: List DSAR Profiles
      description: Find DSAR profiles configured in the BigID environment.
      security:
        - BearerAuth: []
      responses:
        '200':
          description: Profiles retrieved.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/DsarProfile'
  /sar/attributes:
    get:
      tags:
        - DSAR
      operationId: listDsarAttributes
      summary: List DSAR Attributes
      description: Retrieve the identifier attributes available for a selected DSAR profile.
      security:
        - BearerAuth: []
      parameters:
        - name: profile_id
          in: query
          schema:
            type: string
      responses:
        '200':
          description: Attributes retrieved.
          content:
            application/json:
              schema:
                type: object
  /sar/reports:
    post:
      tags:
        - DSAR
      operationId: createDsarReport
      summary: Create A DSAR Report
      description: Submit a DSAR scan request using the BigID API.
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DsarRequest'
      responses:
        '201':
          description: DSAR request accepted.
          content:
            application/json:
              schema:
                type: object
                properties:
                  requestId:
                    type: string
  /sar/reports/{requestId}/status:
    get:
      tags:
        - DSAR
      operationId: getDsarReportStatus
      summary: Get DSAR Report Status
      description: Check the status of a DSAR request to track progress.
      security:
        - BearerAuth: []
      parameters:
        - name: requestId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Status retrieved.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
  /sar/reports/{requestId}/short-report:
    get:
      tags:
        - DSAR
      operationId: getDsarShortReport
      summary: Get DSAR Short Report
      description: Retrieve the DSAR short report in JSON or CSV.
      security:
        - BearerAuth: []
      parameters:
        - name: requestId
          in: path
          required: true
          schema:
            type: string
        - name: format
          in: query
          schema:
            type: string
            enum:
              - json
              - csv
      responses:
        '200':
          description: Report retrieved.
          content:
            application/json:
              schema:
                type: object
            text/csv:
              schema:
                type: string
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
  schemas:
    DsarProfile:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
    DsarRequest:
      type: object
      required:
        - profileId
        - userValues
      properties:
        profileId:
          type: string
        userValues:
          type: array
          items:
            type: object
            properties:
              attributeName:
                type: string
              attributeValue:
                type: string
        skipAlertOnNoData:
          type: boolean