openapi: 3.2.0 info: description: Credo AI server API title: Credo AI server Use Cases API servers: - url: /api/v2/credoai tags: - name: use_cases description: Operations related to use cases paths: /use_cases/{use_case_id}/stakeholders/{id}: delete: description: Remove a stakeholder from the specified use case. operationId: CredoAIWeb.API.V2.UseCase.StakeholderController.delete parameters: - description: The unique ID of the use case. in: path name: use_case_id required: true schema: type: string - description: The unique ID of the stakeholder to be deleted. in: path name: id required: true schema: type: string responses: '204': description: No Content '401': description: Unauthorized content: application/vnd.api+json: schema: $ref: '#/components/schemas/AuthError' '403': description: Forbidden content: application/vnd.api+json: schema: $ref: '#/components/schemas/ForbiddenError' '404': description: Not Found content: application/vnd.api+json: schema: $ref: '#/components/schemas/NotFoundError' security: - Bearer: [] summary: '' tags: - use_cases patch: description: Update the role of an existing stakeholder within the specified use case. operationId: CredoAIWeb.API.V2.UseCase.StakeholderController.update parameters: - description: The unique ID of the stakeholder to be updated. in: path name: id required: true schema: type: string - description: The unique ID of the use case. in: path name: use_case_id required: true schema: type: string responses: '200': description: OK content: application/vnd.api+json: schema: $ref: '#/components/schemas/UseCaseStakeholderResponse' '401': description: Unauthorized content: application/vnd.api+json: schema: $ref: '#/components/schemas/AuthError' '403': description: Forbidden content: application/vnd.api+json: schema: $ref: '#/components/schemas/ForbiddenError' '404': description: Not Found content: application/vnd.api+json: schema: $ref: '#/components/schemas/NotFoundError' security: - Bearer: [] summary: '' tags: - use_cases requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/UseCaseStakeholderUpdateRequest' description: The attributes to update for the stakeholder. /use_cases/{use_case_id}/evidences/{id}: delete: description: Deactivate a specific evidence item associated with a use case. operationId: CredoAIWeb.API.V2.UseCase.EvidenceController.delete parameters: - description: The unique ID of the use case. in: path name: use_case_id required: true schema: type: string - description: The unique ID of the evidence. in: path name: id required: true schema: type: string responses: '204': description: OK '401': description: Unauthorized content: application/vnd.api+json: schema: $ref: '#/components/schemas/AuthError' '403': description: Forbidden content: application/vnd.api+json: schema: $ref: '#/components/schemas/ForbiddenError' '404': description: Not Found content: application/vnd.api+json: schema: $ref: '#/components/schemas/NotFoundError' security: - Bearer: [] summary: '' tags: - use_cases get: description: Retrieve detailed information about a specific evidence item. operationId: CredoAIWeb.API.V2.UseCase.EvidenceController.show parameters: - description: The unique ID of the use case. in: path name: use_case_id required: true schema: type: string - description: The unique ID of the evidence. in: path name: id required: true schema: type: string responses: '200': description: OK content: application/vnd.api+json: schema: $ref: '#/components/schemas/EvidenceResponse' '401': description: Unauthorized content: application/vnd.api+json: schema: $ref: '#/components/schemas/AuthError' '404': description: Not Found content: application/vnd.api+json: schema: $ref: '#/components/schemas/NotFoundError' security: - Bearer: [] summary: '' tags: - use_cases /use_cases/{use_case_id}/stakeholders: get: description: Retrieve a list of all stakeholders associated with a specific use case. operationId: CredoAIWeb.API.V2.UseCase.StakeholderController.index parameters: - description: user,use_case,team in: query name: include required: false x-example: user,use_case,team schema: type: string - description: The unique ID of the use case. in: path name: use_case_id required: true schema: type: string responses: '200': description: OK content: application/vnd.api+json: schema: $ref: '#/components/schemas/UseCasesStakeholdersResponse' '401': description: Unauthorized content: application/vnd.api+json: schema: $ref: '#/components/schemas/AuthError' '404': description: Not Found content: application/vnd.api+json: schema: $ref: '#/components/schemas/NotFoundError' security: - Bearer: [] summary: '' tags: - use_cases post: description: Create a new stakeholder for the specified use case. operationId: CredoAIWeb.API.V2.UseCase.StakeholderController.create parameters: - description: The unique ID of the use case. in: path name: use_case_id required: true schema: type: string responses: '201': description: Created content: application/vnd.api+json: schema: $ref: '#/components/schemas/UseCaseStakeholderResponse' '400': description: Bad Request content: application/vnd.api+json: schema: $ref: '#/components/schemas/UseCaseStakeholderAlreadyExistError' '401': description: Unauthorized content: application/vnd.api+json: schema: $ref: '#/components/schemas/AuthError' '403': description: Forbidden content: application/vnd.api+json: schema: $ref: '#/components/schemas/ForbiddenError' '404': description: Not Found content: application/vnd.api+json: schema: $ref: '#/components/schemas/NotFoundError' security: - Bearer: [] summary: '' tags: - use_cases requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/UseCaseStakeholderCreateRequest' description: The attributes of the stakeholder to be created. /use_cases/{id}: delete: description: Delete a specific use case. Only the owner of the use case can perform this action. operationId: CredoAIWeb.API.V2.UseCaseController.delete parameters: - description: Unique ID of the use case in: path name: id required: true schema: type: string responses: '204': description: No Content '401': description: Unauthorized content: application/vnd.api+json: schema: $ref: '#/components/schemas/AuthError' '403': description: Forbidden content: application/vnd.api+json: schema: $ref: '#/components/schemas/ForbiddenError' '404': description: Not Found content: application/vnd.api+json: schema: $ref: '#/components/schemas/NotFoundError' security: - Bearer: [] summary: '' tags: - use_cases get: description: Fetch detailed information about a specific use case identified by its ID. operationId: CredoAIWeb.API.V2.UseCaseController.show parameters: - description: Unique ID of the use case in: path name: id required: true schema: type: string responses: '200': description: OK content: application/vnd.api+json: schema: $ref: '#/components/schemas/UseCaseResponse' '401': description: Unauthorized content: application/vnd.api+json: schema: $ref: '#/components/schemas/AuthError' '404': description: Not Found content: application/vnd.api+json: schema: $ref: '#/components/schemas/NotFoundError' security: - Bearer: [] summary: '' tags: - use_cases patch: description: Update an existing use case identified by its ID. operationId: CredoAIWeb.API.V2.UseCaseController.update parameters: - description: Unique ID of the use case in: path name: id required: true schema: type: string responses: '200': description: OK content: application/vnd.api+json: schema: $ref: '#/components/schemas/UseCaseResponse' '401': description: Unauthorized content: application/vnd.api+json: schema: $ref: '#/components/schemas/AuthError' '403': description: Forbidden content: application/vnd.api+json: schema: $ref: '#/components/schemas/ForbiddenError' '404': description: Not Found content: application/vnd.api+json: schema: $ref: '#/components/schemas/NotFoundError' security: - Bearer: [] summary: '' tags: - use_cases requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/UseCaseUpdateRequest' description: Attributes to update the use case /use_cases/{use_case_id}/step: patch: description: Update the workflow step of a specific use case. operationId: CredoAIWeb.API.V2.UseCaseController.update_workflow_step parameters: - description: Unique ID of the use case in: path name: use_case_id required: true schema: type: string responses: '200': description: OK content: application/vnd.api+json: schema: $ref: '#/components/schemas/UseCaseResponse' '401': description: Unauthorized content: application/vnd.api+json: schema: $ref: '#/components/schemas/AuthError' '403': description: Forbidden content: application/vnd.api+json: schema: $ref: '#/components/schemas/ForbiddenError' security: - Bearer: [] summary: '' tags: - use_cases requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/UpdateWorkflowStepRequest' description: Workflow step attributes /use_cases/import: post: description: Import multiple use cases from a JSON file. operationId: CredoAIWeb.API.V2.UseCaseController.import responses: '201': description: Created content: application/vnd.api+json: schema: $ref: '#/components/schemas/UseCaseImportResponse' '207': description: Partial success in importing use cases content: application/vnd.api+json: schema: $ref: '#/components/schemas/UseCaseImportResponse' '401': description: Unauthorized content: application/vnd.api+json: schema: $ref: '#/components/schemas/AuthError' '403': description: Forbidden content: application/vnd.api+json: schema: $ref: '#/components/schemas/ForbiddenError' security: - Bearer: [] summary: '' tags: - use_cases requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/UseCasesImportRequest' description: Items to be imported as use cases /use_cases: get: description: Retrieve a list of all use cases. operationId: CredoAIWeb.API.V2.UseCaseController.index parameters: - description: page after cursor in: query name: page[after] required: false schema: type: string - description: page before cursor in: query name: page[before] required: false schema: type: string - description: page limit in: query name: page[limit] required: false schema: type: integer - description: name filter type in: query name: filter[name][type] required: false schema: type: string - description: name filter value in: query name: filter[name][value] required: false schema: type: string - description: id filter type in: query name: filter[id][type] required: false schema: type: string - description: id filter value in: query name: filter[id][value] required: false schema: type: string - description: sort options in: query name: sort required: false x-example: -inserted_at schema: type: string - description: domains in: query name: filter[domains][] required: false schema: type: string - description: ai_type in: query name: filter[ai_type][] required: false schema: type: string - description: in_review in: query name: filter[in_review][] required: false schema: type: string - description: is_vendor in: query name: filter[is_vendor][] required: false schema: type: string - description: policy pack key in: query name: filter[policy_pack_keys][] required: false schema: type: string - description: vendors in: query name: filter[vendors][] required: false schema: type: string - description: has_vendors in: query name: filter[has_vendors][] required: false schema: type: string - description: models in: query name: filter[models][] required: false schema: type: string - description: regions in: query name: filter[regions][] required: false schema: type: string - description: creator_id in: query name: filter[creator_id][] required: false schema: type: string - description: risk_classification_level in: query name: filter[risk_classification_level][] required: false schema: type: string - description: configurable_risk_score_classification in: query name: filter[configurable_risk_score_classification] required: false schema: type: string - description: custom_fields in: query name: filter[custom_fields][] required: false schema: type: string - description: use_case_number in: query name: filter[use_case_number][] required: false schema: type: string - description: has_active_reviewers in: query name: filter[has_active_reviewers][] required: false schema: type: string - description: has_scheduled_reviews in: query name: filter[has_scheduled_reviews][] required: false schema: type: string - description: has_alerts in: query name: filter[has_alerts][] required: false schema: type: string - description: reviewers in: query name: filter[reviewers][] required: false schema: type: string - description: scheduled_review_reviewers in: query name: filter[scheduled_review_reviewers][] required: false schema: type: string - description: workflow_stage_id in: query name: filter[workflow_stage_id][] required: false schema: type: string - description: workflow_stage_step in: query name: filter[workflow_stage_step][] required: false schema: type: string - description: q in: query name: filter[q][] required: false schema: type: string responses: '200': description: OK content: application/vnd.api+json: schema: $ref: '#/components/schemas/UseCasesResponse' '401': description: Unauthorized content: application/vnd.api+json: schema: $ref: '#/components/schemas/AuthError' security: - Bearer: [] summary: '' tags: - use_cases post: description: Create a new use case. operationId: CredoAIWeb.API.V2.UseCaseController.create responses: '201': description: Created content: application/vnd.api+json: schema: $ref: '#/components/schemas/UseCaseResponse' '401': description: Unauthorized content: application/vnd.api+json: schema: $ref: '#/components/schemas/AuthError' '403': description: Forbidden content: application/vnd.api+json: schema: $ref: '#/components/schemas/ForbiddenError' security: - Bearer: [] summary: '' tags: - use_cases requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/UseCaseCreateRequest' description: Attributes of the use case to be created /use_cases/{use_case_id}/workflow_stage: patch: description: Update the workflow stage of a specific use case. operationId: CredoAIWeb.API.V2.UseCaseController.update_workflow_stage parameters: - description: Unique ID of the use case in: path name: use_case_id required: true schema: type: string responses: '200': description: OK content: application/vnd.api+json: schema: $ref: '#/components/schemas/UseCaseResponse' '401': description: Unauthorized content: application/vnd.api+json: schema: $ref: '#/components/schemas/AuthError' '403': description: Forbidden content: application/vnd.api+json: schema: $ref: '#/components/schemas/ForbiddenError' security: - Bearer: [] summary: '' tags: - use_cases requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/UpdateWorkflowStageRequest' description: Workflow stage attributes /use_cases/{use_case_id}/relationships/policy_controls: patch: description: Update the policy controls associated with a specific use case. operationId: CredoAIWeb.API.V2.UseCaseController.upgrade_policy_controls parameters: - description: Unique ID of the use case in: path name: use_case_id required: true schema: type: string responses: '201': description: OK content: application/vnd.api+json: schema: $ref: '#/components/schemas/UseCaseResponse' '401': description: Unauthorized content: application/vnd.api+json: schema: $ref: '#/components/schemas/AuthError' '403': description: Forbidden content: application/vnd.api+json: schema: $ref: '#/components/schemas/ForbiddenError' security: - Bearer: [] summary: '' tags: - use_cases requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/ModifyPolicyPackRequest' description: Relationships to modify policy controls /use_cases/{use_case_id}/risk_classification: patch: description: Update the risk classification of a specific use case. operationId: CredoAIWeb.API.V2.UseCaseController.update_risk_classification parameters: - description: Unique ID of the use case in: path name: use_case_id required: true schema: type: string responses: '200': description: OK content: application/vnd.api+json: schema: $ref: '#/components/schemas/UseCaseResponse' '401': description: Unauthorized content: application/vnd.api+json: schema: $ref: '#/components/schemas/AuthError' '403': description: Forbidden content: application/vnd.api+json: schema: $ref: '#/components/schemas/ForbiddenError' security: - Bearer: [] summary: '' tags: - use_cases requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/UpdateRiskClassificationRequest' description: Risk classification attributes /use_cases/{use_case_id}/vendor_links: get: description: Retrieve a list of vendor links associated with a specific use case. operationId: CredoAIWeb.API.V2.UseCase.VendorLinkController.index parameters: - description: The unique ID of the use case. in: path name: use_case_id required: true schema: type: string responses: '200': description: OK content: application/vnd.api+json: schema: $ref: '#/components/schemas/UseCaseVendorLinksResponse' '401': description: Unauthorized content: application/vnd.api+json: schema: $ref: '#/components/schemas/AuthError' security: - Bearer: [] summary: '' tags: - use_cases post: description: Create a new vendor link for a specific use case. operationId: CredoAIWeb.API.V2.UseCase.VendorLinkController.create parameters: - description: The unique ID of the use case. in: path name: use_case_id required: true schema: type: string responses: '200': description: Created content: application/vnd.api+json: schema: $ref: '#/components/schemas/UseCaseVendorLinkResponse' '401': description: Unauthorized content: application/vnd.api+json: schema: $ref: '#/components/schemas/AuthError' '403': description: Forbidden content: application/vnd.api+json: schema: $ref: '#/components/schemas/ForbiddenError' '404': description: Not Found content: application/vnd.api+json: schema: $ref: '#/components/schemas/NotFoundError' security: - Bearer: [] summary: '' tags: - use_cases requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/UseCaseVendorLinkCreateRequest' description: The attributes for the new vendor link. /use_cases/{use_case_id}/relationships/models: delete: description: Removes models from the specified use case. operationId: CredoAIWeb.API.V2.UseCase.ModelController.remove_models parameters: - description: The unique ID of the use case. in: path name: use_case_id required: true schema: type: string responses: '204': description: No Content '400': description: Bad Request content: application/vnd.api+json: schema: $ref: '#/components/schemas/DatabaseError' '401': description: Unauthorized content: application/vnd.api+json: schema: $ref: '#/components/schemas/AuthError' '403': description: Forbidden content: application/vnd.api+json: schema: $ref: '#/components/schemas/ForbiddenError' '404': description: Not Found content: application/vnd.api+json: schema: $ref: '#/components/schemas/NotFoundError' security: - Bearer: [] summary: '' tags: - use_cases requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/UseCaseModelDeleteRelationships' description: The models to be removed from the use case. post: description: Adds models to the specified use case. operationId: CredoAIWeb.API.V2.UseCase.ModelController.add_models parameters: - description: The unique ID of the use case. in: path name: use_case_id required: true schema: type: string responses: '204': description: No Content '400': description: Bad Request content: application/vnd.api+json: schema: $ref: '#/components/schemas/DatabaseError' '401': description: Unauthorized content: application/vnd.api+json: schema: $ref: '#/components/schemas/AuthError' '403': description: Forbidden content: application/vnd.api+json: schema: $ref: '#/components/schemas/ForbiddenError' '404': description: Not Found content: application/vnd.api+json: schema: $ref: '#/components/schemas/NotFoundError' security: - Bearer: [] summary: '' tags: - use_cases requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/UseCaseModelCreateRelationships' description: The models to be added to the use case. /use_cases/export: get: description: Export use cases to a JSON or CSV file format. operationId: CredoAIWeb.API.V2.UseCaseController.export responses: '200': description: Successfully exported use cases in the requested format content: application/vnd.api+json: schema: allOf: - type: string - $ref: '#/components/schemas/UseCaseExportResponse' '401': description: Unauthorized content: application/vnd.api+json: schema: $ref: '#/components/schemas/AuthError' '403': description: Forbidden content: application/vnd.api+json: schema: $ref: '#/components/schemas/ForbiddenError' security: - Bearer: [] summary: '' tags: - use_cases /use_cases/{use_case_id}/section_assignments: post: description: Creates tasks for multiple sections and assigns them to a user or team operationId: CredoAIWeb.API.V2.UseCase.SectionsAssignmentController.create parameters: - description: The unique ID of the use case in: path name: use_case_id required: true schema: type: string responses: '201': description: Created content: application/vnd.api+json: schema: $ref: '#/components/schemas/TasksResponse' '401': description: Unauthorized content: application/vnd.api+json: schema: $ref: '#/components/schemas/AuthError' '403': description: Forbidden content: application/vnd.api+json: schema: $ref: '#/components/schemas/ForbiddenError' security: - Bearer: [] summary: '' tags: - use_cases requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/SectionAssignmentRequest' description: The task assignment details /use_cases/{use_case_id}/evidences: get: description: List all active evidences related to a specific use case. operationId: CredoAIWeb.API.V2.UseCase.EvidenceController.index parameters: - description: type match filter in: query name: filter[type] required: false schema: type: string - description: sort options in: query name: sort required: false x-example: -inserted_at schema: type: string - description: The unique ID of the use case. in: path name: use_case_id required: true schema: type: string responses: '200': description: OK content: application/vnd.api+json: schema: $ref: '#/components/schemas/EvidencesResponse' '401': description: Unauthorized content: application/vnd.api+json: schema: $ref: '#/components/schemas/AuthError' security: - Bearer: [] summary: '' tags: - use_cases /use_cases/{use_case_id}/vendor_links/{id}: delete: description: Delete a specific vendor link associated with a use case. operationId: CredoAIWeb.API.V2.UseCase.VendorLinkController.delete parameters: - description: The unique ID of the use case. in: path name: use_case_id required: true schema: type: string - description: The unique ID of the vendor link to be deleted. in: path name: id required: true schema: type: string responses: '204': description: No Content '401': description: Unauthorized content: application/vnd.api+json: schema: $ref: '#/components/schemas/AuthError' '403': description: Forbidden content: application/vnd.api+json: schema: $ref: '#/components/schemas/ForbiddenError' '404': description: Not Found content: application/vnd.api+json: schema: $ref: '#/components/schemas/NotFoundError' security: - Bearer: [] summary: '' tags: - use_cases components: schemas: UseCaseCreateRequest: description: '' properties: data: description: '' properties: attributes: properties: ai_type: description: '' type: string description: description: '' type: string icon: description: '' type: string industries: description: Industries example: - Fishing, Hunting, & Trapping type: array is_vendor: description: '' type: boolean monetary_value: description: '' type: integer name: description: '' type: string owner: description: Owner Details example: owner_id: user_id owner_type: user type: object questionnaire_ids: description: Questionnaire Version IDs To Include example: - SEQR+1 - PRIV+2 type: array regions: description: Regions example: - CA - US type: array risk_classification_level: description: Risk Classification Level example: 1 type: integer session_id: description: Session ID - Transfer contexts from this session to the use case type: string source: description: '' type: string system_type: description: '' type: string workflow_stage_id: description: '' type: string required: - name type: object type: description: The JSON-API resource type example: resource-type type: string type: object type: object TasksResponse: description: A collection of [TaskResource](#taskresource) properties: data: description: Content with [TaskResource](#taskresource) objects items: $ref: '#/components/schemas/TaskResource' type: array required: - data type: object SectionAssignmentResource: description: '' properties: attributes: properties: section_ids: description: string type: string team_id: description: '' type: string user_id: description: '' type: string type: object id: description: The JSON-API resource ID example: 64YUaLWSviHgibJaRWr3ZE type: string relationships: properties: {} type: object type: description: The JSON-API resource type example: section_assignments type: string type: object UseCaseStakeholderResource: description: '' properties: attributes: properties: inserted_at: description: '' type: string role: description: '' type: string team_id: description: '' type: string updated_at: description: '' type: string use_case_id: description: '' type: string user_id: description: '' type: string type: object id: description: The JSON-API resource ID example: 64YUaLWSviHgibJaRWr3ZE type: string relationships: properties: team: properties: data: properties: id: description: Related team resource id type: string type: description: Type of related team resource type: string type: object type: object user: properties: data: properties: id: description: Related user resource id type: string type: description: Type of related user resource type: string type: object type: object type: object type: description: The JSON-API resource type example: use_case_stakeholders type: string type: object UseCaseVendorLinksResponse: description: A page of [UseCaseVendorLinkResource](#usecasevendorlinkresource) results properties: data: description: Content with [UseCaseVendorLinkResource](#usecasevendorlinkresource) objects items: $ref: '#/components/schemas/UseCaseVendorLinkResource' type: array meta: properties: after: description: after cursor for the next page resources type: string before: description: before cursor for the previous page resources type: string limit: description: number of resources limit applied to this request type: integer type: object required: - data type: object UseCaseVendorLinkResource: description: '' properties: attributes: properties: inserted_at: description: '' type: string use_case_id: description: '' type: string vendor_id: description: '' type: string type: object id: description: The JSON-API resource ID example: 64YUaLWSviHgibJaRWr3ZE type: string relationships: properties: vendor: properties: data: properties: id: description: Related vendor resource id type: string type: description: Type of related vendor resource type: string type: object type: object type: object type: description: The JSON-API resource type example: use_case_vendor_links type: string type: object UseCasesImportRequest: description: List of use cases to import items: properties: ai_type: description: AI Type of the use case type: string description: description: Description of the use case type: string domains: description: Domains items: type: string type: array icon: description: Icon of the use case type: string industries: description: Industries items: type: string type: array monetary_value: description: The monetary value of a use case type: integer name: description: Name of the use case type: string questionnaires: description: List of questionnaires items: properties: key: description: Questionnaire unique key example: SEQR type: string sections: description: List of sections items: properties: id: description: Section unique identifier example: 64YUaLWSviHgibJaRWr3ZE type: string questions: description: List of questions items: properties: id: description: Question unique identifier example: 64YUaLWSviHgibJaRWr3ZE type: string value: description: Question value example: This is text evidence type: string required: - id - value type: object type: array required: - id - questions type: object type: array version: description: Questionnaire verstion example: 1 type: number required: - key type: object type: array regions: description: Regions items: type: string type: array risk_classification_level: description: Risk Classification Level of the use case type: integer required: - name type: object type: array DatabaseError: properties: errors: description: Errors items: properties: code: description: an application-specific error code, expressed as a string value. type: integer detail: description: a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized. type: string title: description: a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. type: string type: object type: array type: object UseCaseStakeholderResponse: description: A JSON-API document with a single [UseCaseStakeholderResource](#usecasestakeholderresource) resource properties: data: $ref: '#/components/schemas/UseCaseStakeholderResource' included: description: Included resources items: properties: id: description: The JSON-API resource ID type: string type: description: The JSON-API resource type type: string type: object type: array required: - data type: object UseCaseResource: description: '' properties: attributes: properties: monetary_value: description: '' type: string use_case_number: description: '' type: string risk_category_level: description: '' type: string creator_id: description: '' type: string risk_classification_set_at: description: '' type: string calculated_risk_score: description: '' type: string workflow_stage_id: description: '' type: string system_type: description: '' type: string inserted_at: description: '' type: string questionnaire_ids: description: '' type: string industries: description: '' type: string is_vendor: description: '' type: string entity_id: description: '' type: string configurable_risk_score_classification: description: '' type: string risk_score_calculated_at: description: '' type: string workflow_stage_step_status: description: '' type: string workflow_stage_step: description: '' type: string source: description: '' type: string control_refs: description: '' type: string risk_classification_id: description: '' type: string rai_issues_count: description: '' type: string policy_pack_refs: description: '' type: string risk_classification_set_by: description: '' type: string updated_at: description: '' type: string description: description: '' type: string name: description: '' type: string visible: description: '' type: string access_level: description: '' type: string risk_classification_set_by_user_id: description: '' type: string domain_ids: description: '' type: string settings: description: '' type: string alerts_count: description: '' type: string regions: description: '' type: string in_review: description: '' type: string icon: description: '' type: string ai_type: description: '' type: string risk_classification_level: description: '' type: string type: object id: description: The JSON-API resource ID example: 64YUaLWSviHgibJaRWr3ZE type: string relationships: properties: alerts: properties: data: properties: id: description: Related alerts resource id type: string type: description: Type of related alerts resource type: string type: object type: object creator: properties: data: properties: id: description: Related creator resource id type: string type: description: Type of related creator resource type: string type: object type: object custom_fields: properties: data: properties: id: description: Related custom_fields resource id type: string type: description: Type of related custom_fields resource type: string type: object type: object desired_state: properties: data: properties: id: description: Related desired_state resource id type: string type: description: Type of related desired_state resource type: string type: object type: object domain_links: properties: data: properties: id: description: Related domain_links resource id type: string type: description: Type of related domain_links resource type: string type: object type: object domains: properties: data: properties: id: description: Related domains resource id type: string type: description: Type of related domains resource type: string type: object type: object governance_ai_contexts: properties: data: properties: id: description: Related governance_ai_contexts resource id type: string type: description: Type of related governance_ai_contexts resource type: string type: object type: object governance_ai_suggestions: properties: data: properties: id: description: Related governance_ai_suggestions resource id type: string type: description: Type of related governance_ai_suggestions resource type: string type: object type: object model_links: properties: data: items: properties: id: description: Related model_links resource id type: string type: description: Type of related model_links resource type: string type: object type: array type: object models: properties: data: items: properties: id: description: Related models resource id type: string type: description: Type of related models resource type: string type: object type: array type: object policy_packs: properties: data: properties: id: description: Related policy_packs resource id type: string type: description: Type of related policy_packs resource type: string type: object type: object questionnaires: properties: data: properties: id: description: Related questionnaires resource id type: string type: description: Type of related questionnaires resource type: string type: object type: object reviews: properties: data: properties: id: description: Related reviews resource id type: string type: description: Type of related reviews resource type: string type: object type: object risk_scenarios: properties: data: properties: id: description: Related risk_scenarios resource id type: string type: description: Type of related risk_scenarios resource type: string type: object type: object scheduled_reviews: properties: data: properties: id: description: Related scheduled_reviews resource id type: string type: description: Type of related scheduled_reviews resource type: string type: object type: object stakeholders: properties: data: items: properties: id: description: Related stakeholders resource id type: string type: description: Type of related stakeholders resource type: string type: object type: array type: object use_case_sync_issues: properties: data: properties: id: description: Related use_case_sync_issues resource id type: string type: description: Type of related use_case_sync_issues resource type: string type: object type: object vendor_links: properties: data: properties: id: description: Related vendor_links resource id type: string type: description: Type of related vendor_links resource type: string type: object type: object vendors: properties: data: properties: id: description: Related vendors resource id type: string type: description: Type of related vendors resource type: string type: object type: object workflow_stage: properties: data: properties: id: description: Related workflow_stage resource id type: string type: description: Type of related workflow_stage resource type: string type: object type: object type: object type: description: The JSON-API resource type example: use_cases type: string type: object SectionAssignmentRequest: description: A JSON-API document with a single [SectionAssignmentResource](#sectionassignmentresource) resource properties: data: $ref: '#/components/schemas/SectionAssignmentResource' included: description: Included resources items: properties: id: description: The JSON-API resource ID type: string type: description: The JSON-API resource type type: string type: object type: array required: - data type: object UpdateWorkflowStageRequest: description: '' properties: data: description: '' properties: attributes: properties: workflow_stage_id: description: workflow stage ID type: string required: - workflow_stage_id type: object id: description: The JSON-API resource ID example: 64YUaLWSviHgibJaRWr3ZE type: string type: description: The JSON-API resource type example: resource-type type: string type: object type: object UseCaseResponse: description: A JSON-API document with a single [UseCaseResource](#usecaseresource) resource properties: data: $ref: '#/components/schemas/UseCaseResource' included: description: Included resources items: properties: id: description: The JSON-API resource ID type: string type: description: The JSON-API resource type type: string type: object type: array required: - data type: object EvidenceResponse: description: A JSON-API document with a single [EvidenceResource](#evidenceresource) resource properties: data: $ref: '#/components/schemas/EvidenceResource' included: description: Included resources items: properties: id: description: The JSON-API resource ID type: string type: description: The JSON-API resource type type: string type: object type: array required: - data type: object EvidencesResponse: description: A collection of [EvidenceResource](#evidenceresource) properties: data: description: Content with [EvidenceResource](#evidenceresource) objects items: $ref: '#/components/schemas/EvidenceResource' type: array required: - data type: object UseCaseUpdateRequest: description: '' properties: data: description: '' properties: attributes: properties: ai_type: description: '' type: string description: description: '' type: string icon: description: '' type: string industries: description: industries example: - Fishing, Hunting, & Trapping type: array is_vendor: description: '' type: boolean monetary_value: description: '' type: integer name: description: '' type: string regions: description: regions example: - CA - US type: array risk_classification_level: description: Risk classification level example: 1 type: integer settings: description: use case settings example: use_risk_evaluations: false type: object source: description: '' type: string system_type: description: '' type: string type: object id: description: The JSON-API resource ID example: 64YUaLWSviHgibJaRWr3ZE type: string type: description: The JSON-API resource type example: resource-type type: string type: object type: object UseCasesResponse: description: A page of [UseCaseResource](#usecaseresource) results properties: data: description: Content with [UseCaseResource](#usecaseresource) objects items: $ref: '#/components/schemas/UseCaseResource' type: array meta: properties: after: description: after cursor for the next page resources type: string before: description: before cursor for the previous page resources type: string limit: description: number of resources limit applied to this request type: integer type: object required: - data type: object TaskResource: description: '' properties: attributes: properties: assigner_id: description: '' type: string completed_at: description: '' type: string due_date: description: '' type: string entity_questionnaire_section_id: description: '' type: string inserted_at: description: '' type: string model_id: description: '' type: string status: description: '' type: string sub_status: description: '' type: string team_ids: description: '' type: string timezone: description: '' type: string type: description: '' type: string updated_at: description: '' type: string use_case_control_id: description: '' type: string use_case_id: description: '' type: string use_case_review_id: description: '' type: string user_ids: description: '' type: string vendor_id: description: '' type: string type: object id: description: The JSON-API resource ID example: 64YUaLWSviHgibJaRWr3ZE type: string relationships: properties: assigner: properties: data: properties: id: description: Related assigner resource id type: string type: description: Type of related assigner resource type: string type: object type: object entity_questionnaire_section: properties: data: properties: id: description: Related entity_questionnaire_section resource id type: string type: description: Type of related entity_questionnaire_section resource type: string type: object type: object model: properties: data: properties: id: description: Related model resource id type: string type: description: Type of related model resource type: string type: object type: object teams: properties: data: properties: id: description: Related teams resource id type: string type: description: Type of related teams resource type: string type: object type: object use_case: properties: data: properties: id: description: Related use_case resource id type: string type: description: Type of related use_case resource type: string type: object type: object use_case_control: properties: data: properties: id: description: Related use_case_control resource id type: string type: description: Type of related use_case_control resource type: string type: object type: object use_case_review: properties: data: properties: id: description: Related use_case_review resource id type: string type: description: Type of related use_case_review resource type: string type: object type: object users: properties: data: properties: id: description: Related users resource id type: string type: description: Type of related users resource type: string type: object type: object vendor: properties: data: properties: id: description: Related vendor resource id type: string type: description: Type of related vendor resource type: string type: object type: object type: object type: description: The JSON-API resource type example: tasks type: string type: object UseCaseVendorLinkResponse: description: A JSON-API document with a single [UseCaseVendorLinkResource](#usecasevendorlinkresource) resource properties: data: $ref: '#/components/schemas/UseCaseVendorLinkResource' included: description: Included resources items: properties: id: description: The JSON-API resource ID type: string type: description: The JSON-API resource type type: string type: object type: array required: - data type: object UpdateRiskClassificationRequest: description: '' properties: data: description: '' properties: attributes: properties: risk_classification_level: description: Risk classification level example: 1 type: integer type: object id: description: The JSON-API resource ID example: 64YUaLWSviHgibJaRWr3ZE type: string type: description: The JSON-API resource type example: resource-type type: string type: object type: object UseCasesStakeholdersResponse: description: A collection of [UseCaseStakeholderResource](#usecasestakeholderresource) properties: data: description: Content with [UseCaseStakeholderResource](#usecasestakeholderresource) objects items: $ref: '#/components/schemas/UseCaseStakeholderResource' type: array required: - data type: object UseCaseVendorLinkCreateRequest: description: '' properties: data: description: '' properties: attributes: properties: vendor_id: description: vendor ID type: string required: - vendor_id type: object type: description: The JSON-API resource type example: resource-type type: string type: object type: object EvidenceResource: description: '' properties: attributes: properties: control_key: description: Control key example: FAIR.C1 type: string creator: description: Creator example: family_name: John given_name: Doe nickname: doe type: object data: description: value data, example: value: value type: object entity_id: description: '' type: string generated_at: description: Evidence generation time example: '2015-05-22T14:56:29.000Z' type: string hash_key: description: '' type: string inserted_at: description: insert time example: '2015-05-22T14:56:29.000Z' type: string label: description: label in the evidence requirement example: key: value type: object metadata: description: metadata example: key: value type: object model_id: description: model_id example: 4pEfRTw2RVVrouMbFH9tuH type: string model_version: description: '' type: string type: description: Evidence type example: text type: string use_case_id: description: use_case_id example: 64YUaLWSviHgibJaRWr3ZE type: string type: object id: description: The JSON-API resource ID example: 64YUaLWSviHgibJaRWr3ZE type: string relationships: properties: asset_links: properties: data: properties: id: description: Related asset_links resource id type: string type: description: Type of related asset_links resource type: string type: object type: object model: properties: data: properties: id: description: Related model resource id type: string type: description: Type of related model resource type: string type: object type: object policy_pack_links: properties: data: properties: id: description: Related policy_pack_links resource id type: string type: description: Type of related policy_pack_links resource type: string type: object type: object type: object type: description: The JSON-API resource type example: evidences type: string type: object UseCaseExportResponse: description: '' properties: attributes: properties: monetary_value: description: '' type: string use_case_number: description: '' type: string risk_category_level: description: '' type: string creator_id: description: '' type: string risk_classification_set_at: description: '' type: string calculated_risk_score: description: '' type: string workflow_stage_id: description: '' type: string system_type: description: '' type: string inserted_at: description: '' type: string questionnaire_ids: description: '' type: string industries: description: '' type: string is_vendor: description: '' type: string entity_id: description: '' type: string configurable_risk_score_classification: description: '' type: string risk_score_calculated_at: description: '' type: string workflow_stage_step_status: description: '' type: string workflow_stage_step: description: '' type: string source: description: '' type: string control_refs: description: '' type: string risk_classification_id: description: '' type: string rai_issues_count: description: '' type: string policy_pack_refs: description: '' type: string risk_classification_set_by: description: '' type: string updated_at: description: '' type: string description: description: '' type: string name: description: '' type: string visible: description: '' type: string access_level: description: '' type: string risk_classification_set_by_user_id: description: '' type: string domain_ids: description: '' type: string settings: description: '' type: string alerts_count: description: '' type: string regions: description: '' type: string in_review: description: '' type: string icon: description: '' type: string ai_type: description: '' type: string risk_classification_level: description: '' type: string type: object id: description: The JSON-API resource ID example: 64YUaLWSviHgibJaRWr3ZE type: string relationships: properties: alerts: properties: data: properties: id: description: Related alerts resource id type: string type: description: Type of related alerts resource type: string type: object type: object creator: properties: data: properties: id: description: Related creator resource id type: string type: description: Type of related creator resource type: string type: object type: object custom_fields: properties: data: properties: id: description: Related custom_fields resource id type: string type: description: Type of related custom_fields resource type: string type: object type: object desired_state: properties: data: properties: id: description: Related desired_state resource id type: string type: description: Type of related desired_state resource type: string type: object type: object domain_links: properties: data: properties: id: description: Related domain_links resource id type: string type: description: Type of related domain_links resource type: string type: object type: object domains: properties: data: properties: id: description: Related domains resource id type: string type: description: Type of related domains resource type: string type: object type: object governance_ai_contexts: properties: data: properties: id: description: Related governance_ai_contexts resource id type: string type: description: Type of related governance_ai_contexts resource type: string type: object type: object governance_ai_suggestions: properties: data: properties: id: description: Related governance_ai_suggestions resource id type: string type: description: Type of related governance_ai_suggestions resource type: string type: object type: object model_links: properties: data: items: properties: id: description: Related model_links resource id type: string type: description: Type of related model_links resource type: string type: object type: array type: object models: properties: data: items: properties: id: description: Related models resource id type: string type: description: Type of related models resource type: string type: object type: array type: object policy_packs: properties: data: properties: id: description: Related policy_packs resource id type: string type: description: Type of related policy_packs resource type: string type: object type: object questionnaires: properties: data: properties: id: description: Related questionnaires resource id type: string type: description: Type of related questionnaires resource type: string type: object type: object reviews: properties: data: properties: id: description: Related reviews resource id type: string type: description: Type of related reviews resource type: string type: object type: object risk_scenarios: properties: data: properties: id: description: Related risk_scenarios resource id type: string type: description: Type of related risk_scenarios resource type: string type: object type: object scheduled_reviews: properties: data: properties: id: description: Related scheduled_reviews resource id type: string type: description: Type of related scheduled_reviews resource type: string type: object type: object stakeholders: properties: data: items: properties: id: description: Related stakeholders resource id type: string type: description: Type of related stakeholders resource type: string type: object type: array type: object use_case_sync_issues: properties: data: properties: id: description: Related use_case_sync_issues resource id type: string type: description: Type of related use_case_sync_issues resource type: string type: object type: object vendor_links: properties: data: properties: id: description: Related vendor_links resource id type: string type: description: Type of related vendor_links resource type: string type: object type: object vendors: properties: data: properties: id: description: Related vendors resource id type: string type: description: Type of related vendors resource type: string type: object type: object workflow_stage: properties: data: properties: id: description: Related workflow_stage resource id type: string type: description: Type of related workflow_stage resource type: string type: object type: object type: object type: description: The JSON-API resource type example: use_cases type: string type: object ForbiddenError: properties: errors: description: Errors items: properties: code: description: an application-specific error code, expressed as a string value. type: integer detail: description: a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized. type: string title: description: a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. type: string type: object type: array type: object UpdateWorkflowStepRequest: description: '' properties: data: description: '' properties: attributes: properties: workflow_stage_step: description: workflow step. example: - assessment - evidence_collection - clear - rejected type: string required: - workflow_stage_step type: object id: description: The JSON-API resource ID example: 64YUaLWSviHgibJaRWr3ZE type: string type: description: The JSON-API resource type example: resource-type type: string type: object type: object UseCaseImportResponse: description: Import use cases response properties: data: description: Import use cases data properties: details: description: List of details items: properties: error: description: Error details example: 'code: "MISSING_ENTITY_NAME", details: "Missing use case name"' properties: code: description: Error code type: string details: description: Error details type: string type: object id: description: Use case unique identifier type: string index: description: Index of the use case in the import list example: 0 type: integer name: description: Name of the use case type: string status: description: Status of the use case enum: - success - failure example: success type: string type: object type: array status: description: Status of the import enum: - success - failure - partial_success example: success type: string summary: description: Import summary example: '%{total: 2, successful: 1, failed: 1}' properties: failed: description: Number of failed use cases type: integer successful: description: Number of successfully imported use cases type: integer total: description: Total number of attempted use cases to import type: integer type: object type: object type: object AuthError: properties: errors: description: Errors items: properties: code: description: an application-specific error code, expressed as a string value. type: integer detail: description: a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized. type: string title: description: a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. type: string type: object type: array type: object UseCaseModelDeleteRelationships: properties: data: items: properties: id: description: Model ID example: 39cbqQk7gjmAJ55amVoNxm type: string type: description: type example: use_case_model_links type: string type: object type: array type: object UseCaseStakeholderUpdateRequest: description: '' properties: data: description: '' properties: attributes: properties: role: description: role enum: - owner - contributor - observer type: string type: object id: description: The JSON-API resource ID example: 64YUaLWSviHgibJaRWr3ZE type: string type: description: The JSON-API resource type example: resource-type type: string type: object type: object UseCaseStakeholderCreateRequest: description: '' properties: data: description: '' properties: attributes: properties: role: description: '' type: string team_id: description: '' type: string user_id: description: '' type: string type: object type: description: The JSON-API resource type example: resource-type type: string type: object type: object UseCaseModelCreateRelationships: properties: data: items: properties: attributes: properties: model_id: description: Model ID example: 39cbqQk7gjmAJ55amVoNxm type: string model_version: description: Model version example: v0.7 type: string type: object type: description: type example: use_case_model_links type: string type: object type: array type: object ModifyPolicyPackRequest: description: modify policy pack properties: data: items: $ref: '#/components/schemas/ModifyPolicyPackResource' type: array type: object ModifyPolicyPackResource: description: A PolicyPackRel properties: id: description: policy pack id type: string required: - id title: PolicyPackRel type: object UseCaseStakeholderAlreadyExistError: properties: errors: description: Errors items: properties: code: description: an application-specific error code, expressed as a string value. type: integer detail: description: a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized. type: string title: description: a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. type: string type: object type: array type: object NotFoundError: properties: errors: description: Errors items: properties: code: description: an application-specific error code, expressed as a string value. type: integer detail: description: a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized. type: string title: description: a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. type: string type: object type: array type: object securitySchemes: Bearer: in: header name: Authorization type: apiKey