From f1f998c2fae8147c302256a8bcfe98840e2dca65 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Jes=C3=BAs=20Pe=C3=B1a=20Rodr=C3=ADguez?= Date: Wed, 2 Jul 2025 13:19:57 +0200 Subject: [PATCH] chore: update spec (#8162) --- api/src/backend/api/specs/v1.yaml | 1021 ----------------------------- 1 file changed, 1021 deletions(-) diff --git a/api/src/backend/api/specs/v1.yaml b/api/src/backend/api/specs/v1.yaml index 7b212abbec..c17b6e996e 100644 --- a/api/src/backend/api/specs/v1.yaml +++ b/api/src/backend/api/specs/v1.yaml @@ -7,440 +7,6 @@ info: This file is auto-generated. paths: - /api/v1/cloud-user-forgot-passwords: - get: - operationId: cloud_user_forgot_passwords_list - description: Retrieve a list of all cloud users forgot password request in the - system. - summary: List all cloud users forgot password request - parameters: - - in: query - name: fields[cloud-user-forgot-passwords] - schema: - type: array - items: - type: string - enum: - - user - description: endpoint return only specific fields in the response on a per-type - basis by including a fields[TYPE] query parameter. - explode: false - - in: query - name: filter[expires_at] - schema: - type: string - format: date - - in: query - name: filter[expires_at__gte] - schema: - type: string - format: date-time - - in: query - name: filter[expires_at__lte] - schema: - type: string - format: date-time - - in: query - name: filter[forgot_password_token] - schema: - type: string - - in: query - name: filter[forgot_password_token__icontains] - schema: - type: string - - in: query - name: filter[inserted_at] - schema: - type: string - format: date - - in: query - name: filter[inserted_at__date] - schema: - type: string - format: date - - in: query - name: filter[inserted_at__gte] - schema: - type: string - format: date-time - - in: query - name: filter[inserted_at__lte] - schema: - type: string - format: date-time - - name: filter[search] - required: false - in: query - description: A search term. - schema: - type: string - - in: query - name: filter[updated_at] - schema: - type: string - format: date - - in: query - name: filter[updated_at__gte] - schema: - type: string - format: date-time - - in: query - name: filter[updated_at__lte] - schema: - type: string - format: date-time - - name: page[number] - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page[size] - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: sort - required: false - in: query - description: '[list of fields to sort by](https://jsonapi.org/format/#fetching-sorting)' - schema: - type: array - items: - type: string - enum: - - inserted_at - - -inserted_at - - updated_at - - -updated_at - - expires_at - - -expires_at - explode: false - tags: - - Cloud User Forgot Password - security: - - jwtAuth: [] - responses: - '200': - content: - application/vnd.api+json: - schema: - $ref: '#/components/schemas/PaginatedCloudUserForgotPasswordList' - description: '' - /api/v1/cloud-user-forgot-passwords/{id}: - get: - operationId: cloud_user_forgot_passwords_retrieve - description: Retrieve a specific cloud user forgot password request's information - by their ID. - summary: Retrieve a cloud user forgot password request - parameters: - - in: query - name: fields[cloud-user-forgot-passwords] - schema: - type: array - items: - type: string - enum: - - user - description: endpoint return only specific fields in the response on a per-type - basis by including a fields[TYPE] query parameter. - explode: false - - in: path - name: id - schema: - type: string - format: uuid - description: A UUID string identifying this cloud user forgot password. - required: true - tags: - - Cloud User Forgot Password - security: - - jwtAuth: [] - responses: - '200': - content: - application/vnd.api+json: - schema: - $ref: '#/components/schemas/CloudUserForgotPasswordResponse' - description: '' - delete: - operationId: cloud_user_forgot_passwords_destroy - description: Remove a user forgot password request in the system by their ID. - summary: Remove a user forgot password request - parameters: - - in: path - name: id - schema: - type: string - format: uuid - description: A UUID string identifying this cloud user forgot password. - required: true - tags: - - Cloud User Forgot Password - security: - - jwtAuth: [] - responses: - '204': - description: No response body - /api/v1/cloud-user-forgot-passwords/reset: - post: - operationId: cloud_user_forgot_passwords_reset_create - description: Reset the password of a user by providing its email. - summary: Reset a user password - tags: - - Cloud User Forgot Password - requestBody: - content: - application/vnd.api+json: - schema: - $ref: '#/components/schemas/CloudUserForgotPasswordResetRequest' - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/CloudUserForgotPasswordResetRequest' - multipart/form-data: - schema: - $ref: '#/components/schemas/CloudUserForgotPasswordResetRequest' - required: true - security: - - jwtAuth: [] - - {} - responses: - '204': - description: No response body - /api/v1/cloud-user-forgot-passwords/set: - post: - operationId: cloud_user_forgot_passwords_set_create - description: Set the password of a user by providing the forgot password token. - summary: Set a user password - tags: - - Cloud User Forgot Password - requestBody: - content: - application/vnd.api+json: - schema: - $ref: '#/components/schemas/CloudUserForgotPasswordSetRequest' - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/CloudUserForgotPasswordSetRequest' - multipart/form-data: - schema: - $ref: '#/components/schemas/CloudUserForgotPasswordSetRequest' - required: true - security: - - jwtAuth: [] - - {} - responses: - '204': - description: No response body - /api/v1/cloud-user-verifications: - get: - operationId: cloud_user_verifications_list - description: Retrieve a list of all cloud users verifications in the system. - summary: List all cloud users verifications - parameters: - - in: query - name: fields[cloud-user-verifications] - schema: - type: array - items: - type: string - enum: - - inserted_at - - updated_at - - expires_at - - user - - confirmation_token - description: endpoint return only specific fields in the response on a per-type - basis by including a fields[TYPE] query parameter. - explode: false - - in: query - name: filter[confirmation_token] - schema: - type: string - - in: query - name: filter[confirmation_token__icontains] - schema: - type: string - - in: query - name: filter[expires_at] - schema: - type: string - format: date - - in: query - name: filter[expires_at__gte] - schema: - type: string - format: date-time - - in: query - name: filter[expires_at__lte] - schema: - type: string - format: date-time - - in: query - name: filter[inserted_at] - schema: - type: string - format: date - - in: query - name: filter[inserted_at__date] - schema: - type: string - format: date - - in: query - name: filter[inserted_at__gte] - schema: - type: string - format: date-time - - in: query - name: filter[inserted_at__lte] - schema: - type: string - format: date-time - - name: filter[search] - required: false - in: query - description: A search term. - schema: - type: string - - in: query - name: filter[updated_at] - schema: - type: string - format: date - - in: query - name: filter[updated_at__gte] - schema: - type: string - format: date-time - - in: query - name: filter[updated_at__lte] - schema: - type: string - format: date-time - - name: page[number] - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page[size] - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: sort - required: false - in: query - description: '[list of fields to sort by](https://jsonapi.org/format/#fetching-sorting)' - schema: - type: array - items: - type: string - enum: - - inserted_at - - -inserted_at - - updated_at - - -updated_at - - expires_at - - -expires_at - explode: false - tags: - - Cloud User Verification - security: - - jwtAuth: [] - responses: - '200': - content: - application/vnd.api+json: - schema: - $ref: '#/components/schemas/PaginatedCloudUserVerificationList' - description: '' - /api/v1/cloud-user-verifications/{id}: - get: - operationId: cloud_user_verifications_retrieve - description: Retrieve a specific cloud user verification's information by their - ID. - summary: Retrieve a cloud user verification - parameters: - - in: query - name: fields[cloud-user-verifications] - schema: - type: array - items: - type: string - enum: - - inserted_at - - updated_at - - expires_at - - user - - confirmation_token - description: endpoint return only specific fields in the response on a per-type - basis by including a fields[TYPE] query parameter. - explode: false - - in: path - name: id - schema: - type: string - format: uuid - description: A UUID string identifying this cloud user verification. - required: true - tags: - - Cloud User Verification - security: - - jwtAuth: [] - responses: - '200': - content: - application/vnd.api+json: - schema: - $ref: '#/components/schemas/CloudUserVerificationResponse' - description: '' - delete: - operationId: cloud_user_verifications_destroy - description: Remove a tenant email validation in the system by their ID. - summary: Remove a tenant email validation - parameters: - - in: path - name: id - schema: - type: string - format: uuid - description: A UUID string identifying this cloud user verification. - required: true - tags: - - Cloud User Verification - security: - - jwtAuth: [] - responses: - '204': - description: No response body - /api/v1/cloud-user-verifications/confirm: - post: - operationId: cloud_user_verifications_confirm_create - description: Confirm a cloud user token by providing the token. - summary: Confirm a cloud user token - tags: - - Cloud User Verification - requestBody: - content: - application/vnd.api+json: - schema: - $ref: '#/components/schemas/CloudUserVerificationConfirmRequest' - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/CloudUserVerificationConfirmRequest' - multipart/form-data: - schema: - $ref: '#/components/schemas/CloudUserVerificationConfirmRequest' - required: true - security: - - jwtAuth: [] - - {} - responses: - '204': - description: No response body /api/v1/compliance-overviews: get: operationId: compliance_overviews_list @@ -5240,7 +4806,6 @@ paths: - name - manage_users - manage_account - - manage_billing - manage_integrations - manage_providers - manage_scans @@ -5360,8 +4925,6 @@ paths: - -manage_users - manage_account - -manage_account - - manage_billing - - -manage_billing - manage_integrations - -manage_integrations - manage_providers @@ -5439,7 +5002,6 @@ paths: - name - manage_users - manage_account - - manage_billing - manage_integrations - manage_providers - manage_scans @@ -5590,199 +5152,6 @@ paths: responses: '204': description: Relationship deleted successfully - /api/v1/saml-config: - get: - operationId: saml_config_list - description: Returns all the SAML-based SSO configurations associated with the - current tenant. - summary: List all SSO configurations - parameters: - - in: query - name: fields[saml-configurations] - schema: - type: array - items: - type: string - enum: - - email_domain - - metadata_xml - - created_at - - updated_at - description: endpoint return only specific fields in the response on a per-type - basis by including a fields[TYPE] query parameter. - explode: false - - name: filter[search] - required: false - in: query - description: A search term. - schema: - type: string - - name: page[number] - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page[size] - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: sort - required: false - in: query - description: '[list of fields to sort by](https://jsonapi.org/format/#fetching-sorting)' - schema: - type: array - items: - type: string - enum: - - id - - -id - - email_domain - - -email_domain - - metadata_xml - - -metadata_xml - - created_at - - -created_at - - updated_at - - -updated_at - explode: false - tags: - - SAML - security: - - jwtAuth: [] - responses: - '200': - content: - application/vnd.api+json: - schema: - $ref: '#/components/schemas/PaginatedSAMLConfigurationList' - description: '' - post: - operationId: saml_config_create - description: Creates a new SAML SSO configuration for the current tenant, including - email domain and metadata XML. - summary: Create the SSO configuration - tags: - - SAML - requestBody: - content: - application/vnd.api+json: - schema: - $ref: '#/components/schemas/SAMLConfigurationRequest' - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/SAMLConfigurationRequest' - multipart/form-data: - schema: - $ref: '#/components/schemas/SAMLConfigurationRequest' - required: true - security: - - jwtAuth: [] - responses: - '201': - content: - application/vnd.api+json: - schema: - $ref: '#/components/schemas/SAMLConfigurationResponse' - description: '' - /api/v1/saml-config/{id}: - get: - operationId: saml_config_retrieve - description: Returns the details of a specific SAML configuration belonging - to the current tenant. - summary: Retrieve SSO configuration details - parameters: - - in: query - name: fields[saml-configurations] - schema: - type: array - items: - type: string - enum: - - email_domain - - metadata_xml - - created_at - - updated_at - description: endpoint return only specific fields in the response on a per-type - basis by including a fields[TYPE] query parameter. - explode: false - - in: path - name: id - schema: - type: string - format: uuid - description: A UUID string identifying this saml configuration. - required: true - tags: - - SAML - security: - - jwtAuth: [] - responses: - '200': - content: - application/vnd.api+json: - schema: - $ref: '#/components/schemas/SAMLConfigurationResponse' - description: '' - patch: - operationId: saml_config_partial_update - description: Partially updates an existing SAML SSO configuration. Supports - changes to email domain and metadata XML. - summary: Update the SSO configuration - parameters: - - in: path - name: id - schema: - type: string - format: uuid - description: A UUID string identifying this saml configuration. - required: true - tags: - - SAML - requestBody: - content: - application/vnd.api+json: - schema: - $ref: '#/components/schemas/PatchedSAMLConfigurationRequest' - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/PatchedSAMLConfigurationRequest' - multipart/form-data: - schema: - $ref: '#/components/schemas/PatchedSAMLConfigurationRequest' - required: true - security: - - jwtAuth: [] - responses: - '200': - content: - application/vnd.api+json: - schema: - $ref: '#/components/schemas/SAMLConfigurationResponse' - description: '' - delete: - operationId: saml_config_destroy - description: Deletes an existing SAML SSO configuration associated with the - current tenant. - summary: Delete the SSO configuration - parameters: - - in: path - name: id - schema: - type: string - format: uuid - description: A UUID string identifying this saml configuration. - required: true - tags: - - SAML - security: - - jwtAuth: [] - responses: - '204': - description: No response body /api/v1/scans: get: operationId: scans_list @@ -7209,7 +6578,6 @@ paths: - date_joined - memberships - roles - - is_verified description: endpoint return only specific fields in the response on a per-type basis by including a fields[TYPE] query parameter. explode: false @@ -7376,7 +6744,6 @@ paths: - date_joined - memberships - roles - - is_verified description: endpoint return only specific fields in the response on a per-type basis by including a fields[TYPE] query parameter. explode: false @@ -7696,7 +7063,6 @@ paths: - date_joined - memberships - roles - - is_verified description: endpoint return only specific fields in the response on a per-type basis by including a fields[TYPE] query parameter. explode: false @@ -7724,218 +7090,6 @@ paths: description: '' components: schemas: - CloudUserForgotPassword: - type: object - required: - - type - - id - additionalProperties: false - properties: - type: - allOf: - - $ref: '#/components/schemas/CloudUserForgotPasswordTypeEnum' - description: The [type](https://jsonapi.org/format/#document-resource-object-identification) - member is used to describe resource objects that share common attributes - and relationships. - id: {} - relationships: - type: object - properties: - user: - type: object - properties: - data: - type: object - properties: - id: - type: string - format: uri - type: - type: string - enum: - - users - title: Resource Type Name - description: The [type](https://jsonapi.org/format/#document-resource-object-identification) - member is used to describe resource objects that share common - attributes and relationships. - required: - - id - - type - required: - - data - description: The identifier of the related object. - title: Resource Identifier - readOnly: true - CloudUserForgotPasswordResetRequest: - type: object - properties: - data: - type: object - required: - - type - additionalProperties: false - properties: - type: - type: string - description: The [type](https://jsonapi.org/format/#document-resource-object-identification) - member is used to describe resource objects that share common attributes - and relationships. - enum: - - cloud-user-forgot-passwords - attributes: - type: object - properties: - email: - type: string - format: email - writeOnly: true - minLength: 1 - required: - - email - required: - - data - CloudUserForgotPasswordResponse: - type: object - properties: - data: - $ref: '#/components/schemas/CloudUserForgotPassword' - required: - - data - CloudUserForgotPasswordSetRequest: - type: object - properties: - data: - type: object - required: - - type - additionalProperties: false - properties: - type: - type: string - description: The [type](https://jsonapi.org/format/#document-resource-object-identification) - member is used to describe resource objects that share common attributes - and relationships. - enum: - - cloud-user-forgot-passwords - attributes: - type: object - properties: - forgot_password_token: - type: string - writeOnly: true - minLength: 1 - password: - type: string - writeOnly: true - minLength: 1 - required: - - forgot_password_token - - password - required: - - data - CloudUserForgotPasswordTypeEnum: - type: string - enum: - - cloud-user-forgot-passwords - CloudUserVerification: - type: object - required: - - type - - id - additionalProperties: false - properties: - type: - allOf: - - $ref: '#/components/schemas/CloudUserVerificationTypeEnum' - description: The [type](https://jsonapi.org/format/#document-resource-object-identification) - member is used to describe resource objects that share common attributes - and relationships. - id: - type: string - format: uuid - attributes: - type: object - properties: - inserted_at: - type: string - format: date-time - readOnly: true - updated_at: - type: string - format: date-time - readOnly: true - expires_at: - type: string - format: date-time - confirmation_token: - type: string - readOnly: true - relationships: - type: object - properties: - user: - type: object - properties: - data: - type: object - properties: - id: - type: string - format: uri - type: - type: string - enum: - - users - title: Resource Type Name - description: The [type](https://jsonapi.org/format/#document-resource-object-identification) - member is used to describe resource objects that share common - attributes and relationships. - required: - - id - - type - required: - - data - description: The identifier of the related object. - title: Resource Identifier - readOnly: true - CloudUserVerificationConfirmRequest: - type: object - properties: - data: - type: object - required: - - type - additionalProperties: false - properties: - type: - type: string - description: The [type](https://jsonapi.org/format/#document-resource-object-identification) - member is used to describe resource objects that share common attributes - and relationships. - enum: - - cloud-user-verifications - attributes: - type: object - properties: - confirmation_token: - type: string - writeOnly: true - minLength: 1 - required: - - confirmation_token - required: - - data - CloudUserVerificationResponse: - type: object - properties: - data: - $ref: '#/components/schemas/CloudUserVerification' - required: - - data - CloudUserVerificationTypeEnum: - type: string - enum: - - cloud-user-verifications ComplianceOverview: type: object required: @@ -9887,24 +9041,6 @@ components: type: string enum: - findings-severity-overview - PaginatedCloudUserForgotPasswordList: - type: object - properties: - data: - type: array - items: - $ref: '#/components/schemas/CloudUserForgotPassword' - required: - - data - PaginatedCloudUserVerificationList: - type: object - properties: - data: - type: array - items: - $ref: '#/components/schemas/CloudUserVerification' - required: - - data PaginatedComplianceOverviewAttributesList: type: object properties: @@ -10022,15 +9158,6 @@ components: $ref: '#/components/schemas/Role' required: - data - PaginatedSAMLConfigurationList: - type: object - properties: - data: - type: array - items: - $ref: '#/components/schemas/SAMLConfiguration' - required: - - data PaginatedScanList: type: object properties: @@ -10804,8 +9931,6 @@ components: type: boolean manage_account: type: boolean - manage_billing: - type: boolean manage_integrations: type: boolean manage_providers: @@ -10917,52 +10042,6 @@ components: readOnly: true required: - data - PatchedSAMLConfigurationRequest: - type: object - properties: - data: - type: object - required: - - type - - id - additionalProperties: false - properties: - type: - type: string - description: The [type](https://jsonapi.org/format/#document-resource-object-identification) - member is used to describe resource objects that share common attributes - and relationships. - enum: - - saml-configurations - id: - type: string - format: uuid - attributes: - type: object - properties: - email_domain: - type: string - minLength: 1 - description: Email domain used to identify the tenant, e.g. prowlerdemo.com - maxLength: 254 - metadata_xml: - type: string - minLength: 1 - description: Raw IdP metadata XML to configure SingleSignOnService, - certificates, etc. - created_at: - type: string - format: date-time - readOnly: true - updated_at: - type: string - format: date-time - readOnly: true - required: - - email_domain - - metadata_xml - required: - - data PatchedScanUpdateRequest: type: object properties: @@ -12625,8 +11704,6 @@ components: type: boolean manage_account: type: boolean - manage_billing: - type: boolean manage_integrations: type: boolean manage_providers: @@ -12758,8 +11835,6 @@ components: type: boolean manage_account: type: boolean - manage_billing: - type: boolean manage_integrations: type: boolean manage_providers: @@ -12896,8 +11971,6 @@ components: type: boolean manage_account: type: boolean - manage_billing: - type: boolean manage_integrations: type: boolean manage_providers: @@ -13082,97 +12155,6 @@ components: $ref: '#/components/schemas/Role' required: - data - SAMLConfiguration: - type: object - required: - - type - - id - additionalProperties: false - properties: - type: - allOf: - - $ref: '#/components/schemas/SAMLConfigurationTypeEnum' - description: The [type](https://jsonapi.org/format/#document-resource-object-identification) - member is used to describe resource objects that share common attributes - and relationships. - id: - type: string - format: uuid - attributes: - type: object - properties: - email_domain: - type: string - description: Email domain used to identify the tenant, e.g. prowlerdemo.com - maxLength: 254 - metadata_xml: - type: string - description: Raw IdP metadata XML to configure SingleSignOnService, - certificates, etc. - created_at: - type: string - format: date-time - readOnly: true - updated_at: - type: string - format: date-time - readOnly: true - required: - - email_domain - - metadata_xml - SAMLConfigurationRequest: - type: object - properties: - data: - type: object - required: - - type - additionalProperties: false - properties: - type: - type: string - description: The [type](https://jsonapi.org/format/#document-resource-object-identification) - member is used to describe resource objects that share common attributes - and relationships. - enum: - - saml-configurations - attributes: - type: object - properties: - email_domain: - type: string - minLength: 1 - description: Email domain used to identify the tenant, e.g. prowlerdemo.com - maxLength: 254 - metadata_xml: - type: string - minLength: 1 - description: Raw IdP metadata XML to configure SingleSignOnService, - certificates, etc. - created_at: - type: string - format: date-time - readOnly: true - updated_at: - type: string - format: date-time - readOnly: true - required: - - email_domain - - metadata_xml - required: - - data - SAMLConfigurationResponse: - type: object - properties: - data: - $ref: '#/components/schemas/SAMLConfiguration' - required: - - data - SAMLConfigurationTypeEnum: - type: string - enum: - - saml-configurations Scan: type: object required: @@ -13921,9 +12903,6 @@ components: type: string format: date-time readOnly: true - is_verified: - type: boolean - readOnly: true required: - name - email