Skip to content

ApiEndpoints

Víctor Cañizares edited this page Dec 14, 2020 · 1 revision

All URIs are relative to https://demo.iriusrisk.com/api/v1

Class Method HTTP request Description
BusinessUnitsApi businessunitsBusinessUnitIdentifierDelete DELETE /businessunits/{businessUnitIdentifier} Deletes a users business unit
BusinessUnitsApi businessunitsBusinessUnitIdentifierGet GET /businessunits/{businessUnitIdentifier} Gets the business unit details.
BusinessUnitsApi businessunitsBusinessUnitIdentifierPut PUT /businessunits/{businessUnitIdentifier} Update a users business unit
BusinessUnitsApi businessunitsBusinessUnitNameUsersDelete DELETE /businessunits/{businessUnitName}/users Unassign a list of users from a business unit
BusinessUnitsApi businessunitsBusinessUnitNameUsersGet GET /businessunits/{businessUnitName}/users List users from a business unit
BusinessUnitsApi businessunitsBusinessUnitNameUsersPut PUT /businessunits/{businessUnitName}/users Assigns users to a business unit
BusinessUnitsApi businessunitsBusinessUnitNameUsersUserDelete DELETE /businessunits/{businessUnitName}/users/{user} Removes a user from a business unit
BusinessUnitsApi businessunitsGet GET /businessunits Gets a list of all business units
BusinessUnitsApi businessunitsPost POST /businessunits Creates a new user business unit
BusinessUnitsApi groupsGet GET /groups Gets a list of all Groups
BusinessUnitsApi groupsGroupIdentifierDelete DELETE /groups/{groupIdentifier} Deletes a users group
BusinessUnitsApi groupsGroupIdentifierGet GET /groups/{groupIdentifier} Gets the group details.
BusinessUnitsApi groupsGroupIdentifierPut PUT /groups/{groupIdentifier} Update a users group
BusinessUnitsApi groupsGroupUsersDelete DELETE /groups/{group}/users Unassign a list of users from a group
BusinessUnitsApi groupsGroupUsersGet GET /groups/{group}/users List users from a group
BusinessUnitsApi groupsGroupUsersPut PUT /groups/{group}/users Assigns users to a group
BusinessUnitsApi groupsGroupUsersUserDelete DELETE /groups/{group}/users/{user} Removes a user from a group
BusinessUnitsApi groupsPost POST /groups Creates a new user group
ComponentsApi productsRefComponentsComponentRefTestsCwePut PUT /products/{ref}/components/{componentRef}/tests/{cwe} Updates a single test to a component.
ComponentsApi productsRefComponentsComponentRefTestsTestTypeUploadPost POST /products/{ref}/components/{componentRef}/tests/{testType}/upload Imports test results from different sources to a component
ControlsApi productsRefComponentsComponentRefControlsControlRefStatusPut PUT /products/{ref}/components/{componentRef}/controls/{controlRef}/status Sets the desired status to a countermeasure
ControlsApi productsRefControlsGet GET /products/{ref}/controls Gets a list of all product countermeasures
ControlsApi productsRefControlsImplementedGet GET /products/{ref}/controls/implemented Gets a list of all implemented countermeasures of a product.
ControlsApi productsRefControlsRequiredGet GET /products/{ref}/controls/required Gets a list of all required countermeasures of a product
CountermeasuresApi librariesLibraryRefRiskpatternsRiskPatternRefCountermeasuresPost POST /libraries/{libraryRef}/riskpatterns/{riskPatternRef}/countermeasures Creates new countermeasure in a risk pattern
CountermeasuresApi librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefCountermeasuresPut PUT /libraries/{libraryRef}/riskpatterns/{riskPatternRef}/usecases/{useCaseRef}/threats/{threatRef}/countermeasures Associates a countermeasure to a threat in a risk pattern.
CountermeasuresApi librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefWeaknessesWeaknessRefCountermeasuresPut PUT /libraries/{libraryRef}/riskpatterns/{riskPatternRef}/usecases/{useCaseRef}/threats/{threatRef}/weaknesses/{weaknessRef}/countermeasures Associates a countermeasure to a weakness in a risk pattern.
GroupsApi businessunitsBusinessUnitIdentifierDelete DELETE /businessunits/{businessUnitIdentifier} Deletes a users business unit
GroupsApi businessunitsBusinessUnitIdentifierGet GET /businessunits/{businessUnitIdentifier} Gets the business unit details.
GroupsApi businessunitsBusinessUnitIdentifierPut PUT /businessunits/{businessUnitIdentifier} Update a users business unit
GroupsApi businessunitsBusinessUnitNameUsersDelete DELETE /businessunits/{businessUnitName}/users Unassign a list of users from a business unit
GroupsApi businessunitsBusinessUnitNameUsersGet GET /businessunits/{businessUnitName}/users List users from a business unit
GroupsApi businessunitsBusinessUnitNameUsersPut PUT /businessunits/{businessUnitName}/users Assigns users to a business unit
GroupsApi businessunitsBusinessUnitNameUsersUserDelete DELETE /businessunits/{businessUnitName}/users/{user} Removes a user from a business unit
GroupsApi businessunitsGet GET /businessunits Gets a list of all business units
GroupsApi businessunitsPost POST /businessunits Creates a new user business unit
GroupsApi groupsGet GET /groups Gets a list of all Groups
GroupsApi groupsGroupIdentifierDelete DELETE /groups/{groupIdentifier} Deletes a users group
GroupsApi groupsGroupIdentifierGet GET /groups/{groupIdentifier} Gets the group details.
GroupsApi groupsGroupIdentifierPut PUT /groups/{groupIdentifier} Update a users group
GroupsApi groupsGroupUsersDelete DELETE /groups/{group}/users Unassign a list of users from a group
GroupsApi groupsGroupUsersGet GET /groups/{group}/users List users from a group
GroupsApi groupsGroupUsersPut PUT /groups/{group}/users Assigns users to a group
GroupsApi groupsGroupUsersUserDelete DELETE /groups/{group}/users/{user} Removes a user from a group
GroupsApi groupsPost POST /groups Creates a new user group
GroupsApi productsRefGroupsDelete DELETE /products/{ref}/groups Unassigns a list of user groups from a product.
GroupsApi productsRefGroupsGet GET /products/{ref}/groups List all groups assigned to a product
GroupsApi productsRefGroupsPut PUT /products/{ref}/groups Assigns groups of users to a product.
LibrariesApi librariesLibraryRefDelete DELETE /libraries/{libraryRef} Deletes a Library
LibrariesApi librariesLibraryRefGet GET /libraries/{libraryRef} Gets library details
LibrariesApi librariesLibraryRefRiskpatternsPost POST /libraries/{libraryRef}/riskpatterns Creates new Risk Pattern
LibrariesApi librariesLibraryRefRiskpatternsRiskPatternRefCountermeasuresPost POST /libraries/{libraryRef}/riskpatterns/{riskPatternRef}/countermeasures Creates new countermeasure in a risk pattern
LibrariesApi librariesLibraryRefRiskpatternsRiskPatternRefDelete DELETE /libraries/{libraryRef}/riskpatterns/{riskPatternRef} Deletes a Risk Pattern
LibrariesApi librariesLibraryRefRiskpatternsRiskPatternRefGet GET /libraries/{libraryRef}/riskpatterns/{riskPatternRef} Gets Risk Pattern details
LibrariesApi librariesLibraryRefRiskpatternsRiskPatternRefUsecasesPost POST /libraries/{libraryRef}/riskpatterns/{riskPatternRef}/usecases Creates new use case in a library.
LibrariesApi librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsPost POST /libraries/{libraryRef}/riskpatterns/{riskPatternRef}/usecases/{useCaseRef}/threats Creates a new threat in a library.
LibrariesApi librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefCountermeasuresPut PUT /libraries/{libraryRef}/riskpatterns/{riskPatternRef}/usecases/{useCaseRef}/threats/{threatRef}/countermeasures Associates a countermeasure to a threat in a risk pattern.
LibrariesApi librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefWeaknessesPut PUT /libraries/{libraryRef}/riskpatterns/{riskPatternRef}/usecases/{useCaseRef}/threats/{threatRef}/weaknesses Associates weakness to a threat in a risk pattern.
LibrariesApi librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefWeaknessesWeaknessRefCountermeasuresPut PUT /libraries/{libraryRef}/riskpatterns/{riskPatternRef}/usecases/{useCaseRef}/threats/{threatRef}/weaknesses/{weaknessRef}/countermeasures Associates a countermeasure to a weakness in a risk pattern.
LibrariesApi librariesLibraryRefRiskpatternsRiskPatternRefWeaknessesPost POST /libraries/{libraryRef}/riskpatterns/{riskPatternRef}/weaknesses Creates a new weakness in a risk pattern
LibrariesApi librariesPost POST /libraries Creates a Library
LibrariesApi productsUploadPost POST /products/upload Creates a new product, library or template from a XML file upload.
ProductsApi productsGet GET /products Gets a list of all products.
ProductsApi productsPost POST /products Creates a new product
ProductsApi productsRefComponentsComponentRefControlsControlRefStatusPut PUT /products/{ref}/components/{componentRef}/controls/{controlRef}/status Sets the desired status to a countermeasure
ProductsApi productsRefComponentsComponentRefTestsCwePut PUT /products/{ref}/components/{componentRef}/tests/{cwe} Updates a single test to a component.
ProductsApi productsRefComponentsComponentRefTestsTestTypeUploadPost POST /products/{ref}/components/{componentRef}/tests/{testType}/upload Imports test results from different sources to a component
ProductsApi productsRefControlsGet GET /products/{ref}/controls Gets a list of all product countermeasures
ProductsApi productsRefControlsImplementedGet GET /products/{ref}/controls/implemented Gets a list of all implemented countermeasures of a product.
ProductsApi productsRefControlsRequiredGet GET /products/{ref}/controls/required Gets a list of all required countermeasures of a product
ProductsApi productsRefDelete DELETE /products/{ref} Deletes a product
ProductsApi productsRefDiagramImageGet GET /products/{ref}/diagram/image Gets diagram image for product.
ProductsApi productsRefGet GET /products/{ref} Gets product details
ProductsApi productsRefGroupsDelete DELETE /products/{ref}/groups Unassigns a list of user groups from a product.
ProductsApi productsRefGroupsGet GET /products/{ref}/groups List all groups assigned to a product
ProductsApi productsRefGroupsPut PUT /products/{ref}/groups Assigns groups of users to a product.
ProductsApi productsRefPut PUT /products/{ref} Updates a product
ProductsApi productsRefRisksGet GET /products/{ref}/risks Gets the risks summary of a product
ProductsApi productsRefTestsTestTypeUploadPost POST /products/{ref}/tests/{testType}/upload Imports test results from different sources to a product.
ProductsApi productsRefThreatsGet GET /products/{ref}/threats Gets a list of all threats of a product
ProductsApi productsRefUsersDelete DELETE /products/{ref}/users Unassigns a list of users from a product.
ProductsApi productsRefUsersGet GET /products/{ref}/users List all users assigned to a product
ProductsApi productsRefUsersPut PUT /products/{ref}/users Assigns users to a product.
ProductsApi productsRefUsersUserDelete DELETE /products/{ref}/users/{user} Unassigns a user from a product
ProductsApi productsRefWeaknessesGet GET /products/{ref}/weaknesses Gets a list of all weaknesses of a product
ProductsApi productsRefWeaknessesTestStateGet GET /products/{ref}/weaknesses/{test_state} Gets a list of all weaknesses of a product filtered by test state
ProductsApi productsUploadPost POST /products/upload Creates a new product, library or template from a XML file upload.
ProductsApi productsUploadRefPost POST /products/upload/{ref} Updates an existing product from a XML file upload.
ProductsApi rulesProductRefPut PUT /rules/product/{ref} Executes rules by a product
RiskPatternsApi librariesLibraryRefRiskpatternsPost POST /libraries/{libraryRef}/riskpatterns Creates new Risk Pattern
RiskPatternsApi librariesLibraryRefRiskpatternsRiskPatternRefCountermeasuresPost POST /libraries/{libraryRef}/riskpatterns/{riskPatternRef}/countermeasures Creates new countermeasure in a risk pattern
RiskPatternsApi librariesLibraryRefRiskpatternsRiskPatternRefDelete DELETE /libraries/{libraryRef}/riskpatterns/{riskPatternRef} Deletes a Risk Pattern
RiskPatternsApi librariesLibraryRefRiskpatternsRiskPatternRefGet GET /libraries/{libraryRef}/riskpatterns/{riskPatternRef} Gets Risk Pattern details
RiskPatternsApi librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefWeaknessesPut PUT /libraries/{libraryRef}/riskpatterns/{riskPatternRef}/usecases/{useCaseRef}/threats/{threatRef}/weaknesses Associates weakness to a threat in a risk pattern.
RiskPatternsApi librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefWeaknessesWeaknessRefCountermeasuresPut PUT /libraries/{libraryRef}/riskpatterns/{riskPatternRef}/usecases/{useCaseRef}/threats/{threatRef}/weaknesses/{weaknessRef}/countermeasures Associates a countermeasure to a weakness in a risk pattern.
RiskPatternsApi librariesLibraryRefRiskpatternsRiskPatternRefWeaknessesPost POST /libraries/{libraryRef}/riskpatterns/{riskPatternRef}/weaknesses Creates a new weakness in a risk pattern
RisksApi productsRefRisksGet GET /products/{ref}/risks Gets the risks summary of a product
RolesApi rolesPost POST /roles Creates a new Role
RolesApi rolesRoleNameDelete DELETE /roles/{role_name} Deletes an existing role
RulesApi rulesProductRefPut PUT /rules/product/{ref} Executes rules by a product
TemplatesApi productsUploadPost POST /products/upload Creates a new product, library or template from a XML file upload.
TestsApi productsRefComponentsComponentRefTestsCwePut PUT /products/{ref}/components/{componentRef}/tests/{cwe} Updates a single test to a component.
TestsApi productsRefComponentsComponentRefTestsTestTypeUploadPost POST /products/{ref}/components/{componentRef}/tests/{testType}/upload Imports test results from different sources to a component
TestsApi productsRefTestsTestTypeUploadPost POST /products/{ref}/tests/{testType}/upload Imports test results from different sources to a product.
ThreatsApi librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsPost POST /libraries/{libraryRef}/riskpatterns/{riskPatternRef}/usecases/{useCaseRef}/threats Creates a new threat in a library.
ThreatsApi librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefCountermeasuresPut PUT /libraries/{libraryRef}/riskpatterns/{riskPatternRef}/usecases/{useCaseRef}/threats/{threatRef}/countermeasures Associates a countermeasure to a threat in a risk pattern.
ThreatsApi librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefWeaknessesPut PUT /libraries/{libraryRef}/riskpatterns/{riskPatternRef}/usecases/{useCaseRef}/threats/{threatRef}/weaknesses Associates weakness to a threat in a risk pattern.
ThreatsApi librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefWeaknessesWeaknessRefCountermeasuresPut PUT /libraries/{libraryRef}/riskpatterns/{riskPatternRef}/usecases/{useCaseRef}/threats/{threatRef}/weaknesses/{weaknessRef}/countermeasures Associates a countermeasure to a weakness in a risk pattern.
ThreatsApi productsRefThreatsGet GET /products/{ref}/threats Gets a list of all threats of a product
TokenApi usersUsernameTokenPost POST /users/{username}/token Generates a user API token
UseCasesApi librariesLibraryRefRiskpatternsRiskPatternRefUsecasesPost POST /libraries/{libraryRef}/riskpatterns/{riskPatternRef}/usecases Creates new use case in a library.
UseCasesApi librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefCountermeasuresPut PUT /libraries/{libraryRef}/riskpatterns/{riskPatternRef}/usecases/{useCaseRef}/threats/{threatRef}/countermeasures Associates a countermeasure to a threat in a risk pattern.
UseCasesApi librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefWeaknessesPut PUT /libraries/{libraryRef}/riskpatterns/{riskPatternRef}/usecases/{useCaseRef}/threats/{threatRef}/weaknesses Associates weakness to a threat in a risk pattern.
UseCasesApi librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefWeaknessesWeaknessRefCountermeasuresPut PUT /libraries/{libraryRef}/riskpatterns/{riskPatternRef}/usecases/{useCaseRef}/threats/{threatRef}/weaknesses/{weaknessRef}/countermeasures Associates a countermeasure to a weakness in a risk pattern.
UsersApi businessunitsBusinessUnitNameUsersDelete DELETE /businessunits/{businessUnitName}/users Unassign a list of users from a business unit
UsersApi businessunitsBusinessUnitNameUsersGet GET /businessunits/{businessUnitName}/users List users from a business unit
UsersApi businessunitsBusinessUnitNameUsersPut PUT /businessunits/{businessUnitName}/users Assigns users to a business unit
UsersApi businessunitsBusinessUnitNameUsersUserDelete DELETE /businessunits/{businessUnitName}/users/{user} Removes a user from a business unit
UsersApi groupsGroupUsersDelete DELETE /groups/{group}/users Unassign a list of users from a group
UsersApi groupsGroupUsersGet GET /groups/{group}/users List users from a group
UsersApi groupsGroupUsersPut PUT /groups/{group}/users Assigns users to a group
UsersApi groupsGroupUsersUserDelete DELETE /groups/{group}/users/{user} Removes a user from a group
UsersApi productsRefUsersDelete DELETE /products/{ref}/users Unassigns a list of users from a product.
UsersApi productsRefUsersGet GET /products/{ref}/users List all users assigned to a product
UsersApi productsRefUsersPut PUT /products/{ref}/users Assigns users to a product.
UsersApi productsRefUsersUserDelete DELETE /products/{ref}/users/{user} Unassigns a user from a product
UsersApi usersGet GET /users List of all Users.
UsersApi usersPost POST /users Creates a new user
UsersApi usersUsernameDelete DELETE /users/{username} Deletes a user
UsersApi usersUsernameGet GET /users/{username} Get all the information of a user
UsersApi usersUsernameTokenPost POST /users/{username}/token Generates a user API token
WeaknessesApi librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefWeaknessesPut PUT /libraries/{libraryRef}/riskpatterns/{riskPatternRef}/usecases/{useCaseRef}/threats/{threatRef}/weaknesses Associates weakness to a threat in a risk pattern.
WeaknessesApi librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefWeaknessesWeaknessRefCountermeasuresPut PUT /libraries/{libraryRef}/riskpatterns/{riskPatternRef}/usecases/{useCaseRef}/threats/{threatRef}/weaknesses/{weaknessRef}/countermeasures Associates a countermeasure to a weakness in a risk pattern.
WeaknessesApi librariesLibraryRefRiskpatternsRiskPatternRefWeaknessesPost POST /libraries/{libraryRef}/riskpatterns/{riskPatternRef}/weaknesses Creates a new weakness in a risk pattern
WeaknessesApi productsRefWeaknessesGet GET /products/{ref}/weaknesses Gets a list of all weaknesses of a product
WeaknessesApi productsRefWeaknessesTestStateGet GET /products/{ref}/weaknesses/{test_state} Gets a list of all weaknesses of a product filtered by test state
Clone this wiki locally