@@ -3980,6 +3980,114 @@ components:
39803980 description: The `markdownTextAnnotation` `text`.
39813981 type: string
39823982 type: object
3983+ AnonymizeUserError:
3984+ description: Error encountered when anonymizing a specific user.
3985+ properties:
3986+ error:
3987+ description: Error message describing why anonymization failed.
3988+ example: ""
3989+ type: string
3990+ user_id:
3991+ description: UUID of the user that failed to be anonymized.
3992+ example: "00000000-0000-0000-0000-000000000000"
3993+ type: string
3994+ required:
3995+ - user_id
3996+ - error
3997+ type: object
3998+ AnonymizeUsersRequest:
3999+ description: Request body for anonymizing users.
4000+ properties:
4001+ data:
4002+ $ref: "#/components/schemas/AnonymizeUsersRequestData"
4003+ required:
4004+ - data
4005+ type: object
4006+ AnonymizeUsersRequestAttributes:
4007+ description: Attributes of an anonymize users request.
4008+ properties:
4009+ user_ids:
4010+ description: List of user IDs (UUIDs) to anonymize.
4011+ example:
4012+ - "00000000-0000-0000-0000-000000000000"
4013+ items:
4014+ example: "00000000-0000-0000-0000-000000000000"
4015+ type: string
4016+ type: array
4017+ required:
4018+ - user_ids
4019+ type: object
4020+ AnonymizeUsersRequestData:
4021+ description: Object to anonymize a list of users.
4022+ properties:
4023+ attributes:
4024+ $ref: "#/components/schemas/AnonymizeUsersRequestAttributes"
4025+ id:
4026+ description: Unique identifier for the request. Not used server-side.
4027+ example: "00000000-0000-0000-0000-000000000000"
4028+ type: string
4029+ type:
4030+ $ref: "#/components/schemas/AnonymizeUsersRequestType"
4031+ required:
4032+ - type
4033+ - attributes
4034+ type: object
4035+ AnonymizeUsersRequestType:
4036+ default: anonymize_users_request
4037+ description: Type of the anonymize users request.
4038+ enum:
4039+ - anonymize_users_request
4040+ example: anonymize_users_request
4041+ type: string
4042+ x-enum-varnames:
4043+ - ANONYMIZE_USERS_REQUEST
4044+ AnonymizeUsersResponse:
4045+ description: Response containing the result of an anonymize users request.
4046+ properties:
4047+ data:
4048+ $ref: "#/components/schemas/AnonymizeUsersResponseData"
4049+ type: object
4050+ AnonymizeUsersResponseAttributes:
4051+ description: Attributes of an anonymize users response.
4052+ properties:
4053+ anonymize_errors:
4054+ description: List of errors encountered during anonymization, one entry per failed user.
4055+ items:
4056+ $ref: "#/components/schemas/AnonymizeUserError"
4057+ type: array
4058+ anonymized_user_ids:
4059+ description: List of user IDs (UUIDs) that were successfully anonymized.
4060+ example:
4061+ - "00000000-0000-0000-0000-000000000000"
4062+ items:
4063+ example: "00000000-0000-0000-0000-000000000000"
4064+ type: string
4065+ type: array
4066+ required:
4067+ - anonymized_user_ids
4068+ - anonymize_errors
4069+ type: object
4070+ AnonymizeUsersResponseData:
4071+ description: Response data for anonymizing users.
4072+ properties:
4073+ attributes:
4074+ $ref: "#/components/schemas/AnonymizeUsersResponseAttributes"
4075+ id:
4076+ description: Unique identifier of the response.
4077+ example: "00000000-0000-0000-0000-000000000000"
4078+ type: string
4079+ type:
4080+ $ref: "#/components/schemas/AnonymizeUsersResponseType"
4081+ type: object
4082+ AnonymizeUsersResponseType:
4083+ default: anonymize_users_response
4084+ description: Type of the anonymize users response.
4085+ enum:
4086+ - anonymize_users_response
4087+ example: anonymize_users_response
4088+ type: string
4089+ x-enum-varnames:
4090+ - ANONYMIZE_USERS_RESPONSE
39834091 AnthropicAPIKey:
39844092 description: The definition of the `AnthropicAPIKey` object.
39854093 properties:
@@ -83081,6 +83189,53 @@ paths:
8308183189 operator: OR
8308283190 permissions:
8308383191 - security_monitoring_findings_read
83192+ /api/v2/anonymize_users:
83193+ put:
83194+ description: |-
83195+ Anonymize a list of users, removing their personal data. This operation is irreversible.
83196+ Requires the `user_access_manage` permission.
83197+ operationId: AnonymizeUsers
83198+ requestBody:
83199+ content:
83200+ application/json:
83201+ schema:
83202+ $ref: "#/components/schemas/AnonymizeUsersRequest"
83203+ required: true
83204+ responses:
83205+ "200":
83206+ content:
83207+ application/json:
83208+ schema:
83209+ $ref: "#/components/schemas/AnonymizeUsersResponse"
83210+ description: OK
83211+ "400":
83212+ content:
83213+ application/json:
83214+ schema:
83215+ $ref: "#/components/schemas/APIErrorResponse"
83216+ description: Bad Request
83217+ "403":
83218+ content:
83219+ application/json:
83220+ schema:
83221+ $ref: "#/components/schemas/APIErrorResponse"
83222+ description: Authentication error
83223+ "429":
83224+ $ref: "#/components/responses/TooManyRequestsResponse"
83225+ security:
83226+ - apiKeyAuth: []
83227+ appKeyAuth: []
83228+ - AuthZ:
83229+ - user_access_manage
83230+ summary: Anonymize users
83231+ tags:
83232+ - Users
83233+ x-codegen-request-body-name: body
83234+ x-permission:
83235+ operator: OR
83236+ permissions:
83237+ - user_access_manage
83238+ x-unstable: "**Note**: This endpoint is in Preview and may be subject to changes."
8308483239 /api/v2/api_keys:
8308583240 get:
8308683241 description: List all API keys available for your account.
0 commit comments