id
+ is the internal identifier for the SCM configuration.ownerId
+ is the identifier for the ownerType specified.repositoryUrl
+ indicates the URL of application/organization. Will indicate 'null' for
+ organizations.provider is the name of the source
+ code host for the parent. Values can be Azure, GitHub, GitLab and Bitbucket.username
+ is returned if found for the specific provider. Currently, the values
+ are available for Bitbucket Server and Bitbucket Cloud.token
+ is obfuscated and indicates the composite configuration for the source
+ control host.baseBranch shows the base branch name.remediationPullRequestsEnabled
+ indicates if the Automated Pull Request feature is enabled.statusChecksEnabled
+ indicates if the status checks for the source code are enabled.pullRequestCommentingEnabled
+ indicates if PR commenting is enabled for this application/organization.sourceControlEvaluationsEnabled
+ indicates if the evaluations triggered by the IQ Server are enabled, for
+ the Continuous Risk Profile feature.sshEnabled indicates
+ if ssh settings are enabled.commitStatusEnabled
+ indicates if commit status check is enabled.Permissions + required: View IQ Elements' + operationId: getParentDataRetentionPolicies + parameters: + - description: The organizationId assigned by IQ Server. Use the organization + REST API to retrieve the parent organizationId + in: path + name: organizationId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ApiDataRetentionPoliciesDTO' + description: The response JSON contains the policy settings for both applicationReports + and successMetrics. Policy settings for application reports are shown + for each stage of development.
Permissions - required: View IQ Elements' - operationId: getParentDataRetentionPolicies + description: 'Use this method to retrieve the priorities for the specified application + Id and scan Id + + + Permissions required: View IQ Elements ' + operationId: getPrioritiesExport parameters: - - description: The organizationId assigned by IQ Server. Use the organization - REST API to retrieve the parent organizationId - in: path - name: organizationId + - in: path + name: applicationId + required: true + schema: + type: string + - in: path + name: scanId required: true schema: type: string responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ApiDataRetentionPoliciesDTO' - description: The response JSON contains the policy settings for both applicationReports - and successMetrics. Policy settings for application reports are shown - for each stage of development.
Use this endpoint + to evaluate malware for a list of components up to a maximum of 100 components + in a single request.A hash or packageUrl (or both) can be supplied for each + component that are of the same format type. + operationId: evaluateMalware + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ApiMalwareComponentEvaluationRequestList' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MalwareDefenseResponseList' + description: Malware evaluation results for the components + tags: + - Malware + /api/v2/malware/defense/metrics: + get: + description: The response contains malware defense API metrics.
Use this endpoint + to get the count of malicious components evaluated via malware defense API + grouped by format. + operationId: getMalwareDefenseMetrics + responses: + '200': + content: + application/json: + schema: + additionalProperties: + format: int64 + type: integer + type: object + description: Malware defense metrics grouped by format. + tags: + - Malware /api/v2/organizations: get: operationId: getOrganizations @@ -6637,6 +7264,32 @@ paths: if the violation is due to an 'InnerSource' component. tags: - Policy Violation Details + /api/v2/policyViolations/{violationId}/applicableAutoWaiver: + get: + description: 'Use this method to obtain the existing auto waiver applicable + to a policy violationviolation. + + + Permissions required: View IQ Elements' + operationId: getApplicableAutoWaiver + parameters: + - description: 'Enter the policy violationId for which you want to obtain the + applicable auto policy waiver ' + in: path + name: violationId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ApiAutoPolicyWaiverDTO' + description: 'The response contains details for applicable auto waiver for + the `violationId` specified. ' + tags: + - Policy Violation Details /api/v2/policyViolations/{violationId}/applicableWaivers: get: description: 'Use this method to obtain all existing waivers that are applicable @@ -7427,9 +8080,17 @@ paths: - Repositories /api/v2/roleMemberships/{ownerType}: get: + description: 'Use this method to retrieve all users and roles globally or for + all repositories. + + + Permissions required: Edit system configuration and users for a global context + or view IQ elements for a non-global context' operationId: getRoleMembershipsGlobalOrRepositoryContainer parameters: - - in: path + - description: Enter the value for ownerType. Using `global` will return the + users and groups who have been assigned the administrator role. + in: path name: ownerType required: true schema: @@ -7443,19 +8104,28 @@ paths: pattern: global|repository_container type: string responses: - default: + '200': content: application/json: schema: $ref: '#/components/schemas/ApiRoleMemberMappingListDTO' - description: default response + description: The response contains all role Ids and the corresponding users/user + groups assigned to them, for the ownerType specified. It also includes + members who inherit a role based on the organization hierarchy. tags: - Role Memberships /api/v2/roleMemberships/{ownerType}/role/{roleId}/{memberType}/{memberName}: delete: + description: 'Use this method to revoke roles globally or on all repositories. + + + Permissions required: Edit system configuration and users for a global context + or view IQ elements for a non-global context' operationId: revokeRoleMembershipGlobalOrRepositoryContainer parameters: - - in: path + - description: Enter the value for ownerType. Using `global` will revoke the + administrator role. + in: path name: ownerType required: true schema: @@ -7468,12 +8138,14 @@ paths: - global pattern: global|repository_container type: string - - in: path + - description: Enter the roleId for the role to be revoked. + in: path name: roleId required: true schema: type: string - - in: path + - description: Enter the value for memberType, to specify a user or a user group. + in: path name: memberType required: true schema: @@ -7482,22 +8154,30 @@ paths: - GROUP pattern: user|group type: string - - in: path + - description: Enter the value for memberName. This can be a username or group + name depending upon the value of memberType above. + in: path name: memberName required: true schema: type: string responses: - default: - content: - '*/*': {} - description: default response + '204': + description: The specified role has been revoked from the user or user group. tags: - Role Memberships put: + description: 'Use this method to grant a role to a user or user group globally + or on all repositories. + + + Permissions required: Edit system configuration and users for a global context + or edit access control for a non-global context' operationId: grantRoleMembershipGlobalOrRepositoryContainer parameters: - - in: path + - description: Enter the value for the ownerType for which you want to grant + the role. + in: path name: ownerType required: true schema: @@ -7510,12 +8190,17 @@ paths: - global pattern: global|repository_container type: string - - in: path + - description: 'Enter the roleId for the role to be granted. + + + Use the Roles REST API for roleIds and descriptions.' + in: path name: roleId required: true schema: type: string - - in: path + - description: Enter the value for memberType, to specify a user or a user group. + in: path name: memberType required: true schema: @@ -7524,23 +8209,32 @@ paths: - GROUP pattern: user|group type: string - - in: path + - description: Enter the value for memberName. This can be a username or group + name depending upon the value of memberType above. + in: path name: memberName required: true schema: type: string responses: - default: - content: - '*/*': {} - description: default response + '200': + description: The specified role has been granted to the users or user groups + on the given context. tags: - Role Memberships /api/v2/roleMemberships/{ownerType}/{internalOwnerId}: get: + description: 'Use this method to retrieve the users, user groups and the corresponding + role Ids. + + + Permissions required: Edit system configuration and users for a global context + or view IQ elements for a non-global context' operationId: getRoleMembershipsApplicationOrOrganization parameters: - - in: path + - description: Enter the ownerType for which you want to retrieve users and + their role Ids. + in: path name: ownerType required: true schema: @@ -7553,25 +8247,35 @@ paths: - global pattern: application|organization type: string - - in: path + - description: Enter the corresponding id for the ownerType specified above. + in: path name: internalOwnerId required: true schema: type: string responses: - default: + '200': content: application/json: schema: $ref: '#/components/schemas/ApiRoleMemberMappingListDTO' - description: default response + description: The response contains the assigned role Ids, users and user + groups for the application or organization requested. It also includes + members who inherit a role based on the organization hierarchy. tags: - Role Memberships /api/v2/roleMemberships/{ownerType}/{internalOwnerId}/role/{roleId}/{memberType}/{memberName}: delete: + description: 'Use this method to revoke a role from a user or user group, on + a specific application or organization. + + + Permissions required: Edit access control' operationId: revokeRoleMembershipApplicationOrOrganization parameters: - - in: path + - description: Enter the value for the ownerType for which you want to revoke + the role. Using `global` will revoke the administrator role. + in: path name: ownerType required: true schema: @@ -7584,17 +8288,21 @@ paths: - global pattern: application|organization type: string - - in: path + - description: Enter the internalId associated with the ownerType specified + above. + in: path name: internalOwnerId required: true schema: type: string - - in: path + - description: Enter the roleId for the role to be revoked. + in: path name: roleId required: true schema: type: string - - in: path + - description: Enter the value for memberType, to specify a user or a user group. + in: path name: memberType required: true schema: @@ -7603,22 +8311,29 @@ paths: - GROUP pattern: user|group type: string - - in: path + - description: Enter the value for memberName. This can be a username or group + name depending upon the value of memberType above. + in: path name: memberName required: true schema: type: string responses: - default: - content: - '*/*': {} - description: default response + '204': + description: The specified role has been revoked from the user or user group tags: - Role Memberships put: + description: 'Use this method to grant a role to a user or user group for the + specified application or organization. + + + Permissions required: Edit access control' operationId: grantRoleMembershipApplicationOrOrganization parameters: - - in: path + - description: Enter the value for the ownerType for which you want to grant + the role. + in: path name: ownerType required: true schema: @@ -7631,17 +8346,24 @@ paths: - global pattern: application|organization type: string - - in: path + - description: Enter the value for the internalId associated with the ownerType + specified above. + in: path name: internalOwnerId required: true schema: type: string - - in: path + - description: 'Enter the roleId for the role to be granted. + + + Use the Roles REST API for roleIds and descriptions.' + in: path name: roleId required: true schema: type: string - - in: path + - description: Enter the value for memberType, to specify a user or a user group. + in: path name: memberType required: true schema: @@ -7650,28 +8372,33 @@ paths: - GROUP pattern: user|group type: string - - in: path + - description: Enter the value for memberName. This can be a username or group + name depending upon the value of memberType above. + in: path name: memberName required: true schema: type: string responses: - default: - content: - '*/*': {} - description: default response + '200': + description: The specified roleId has been has been granted to the user + or user group for the requested context. tags: - Role Memberships /api/v2/roles: get: + description: 'Use this method to view the role IDs, role names and descriptions. + + + Permissions required: View All Roles' operationId: getRoles responses: - default: + '200': content: application/json: schema: $ref: '#/components/schemas/ApiRoleListDTO' - description: default response + description: The response contains the role IDs, role names and descriptions. tags: - Roles /api/v2/sbom/applications/{applicationId}: @@ -8006,6 +8733,13 @@ paths: post: description: Imports a new sbom version to an existing application operationId: importSbom + parameters: + - description: Enable importing as a binary file. default = false + in: query + name: enableBinaryImport + schema: + default: false + type: boolean requestBody: content: '*/*': @@ -8014,8 +8748,10 @@ paths: applicationId: description: The internal id of the application type: string + applicationVersion: + type: string file: - type: object + $ref: '#/components/schemas/FormDataContentDisposition' required: - applicationId type: object @@ -8306,15 +9042,26 @@ paths: - Solutions /api/v2/sourceControl/automaticRoleAssignment/{publicId}: post: + description: 'Use this method to automatically grant the ''developer'' role + to all contributors of a repository on a given application. + + + Prerequisites for automatic role assignment are:
id is the owner internal ID.repositoryUrl
+ indicates the http(s) and ssh urls for the application specified in the
+ ownerId.username is retrieved if available on the
+ SCM system, e.g. for Bitbucket Server and Cloud.provider
+ indicates the name of the SCM system.baseBranch
+ indicates the name of the last selected branch.enablePullRequests
+ has been deprecated in version 124.remediationPullRequestsEnabled
+ indicates if the Automated Pull Requests feature is enabled.enableStatusChecks
+ has been deprecated in version 124.statusChecksEnabled
+ is an internal field.pullRequestCommentingEnabled
+ indicates if the Pull Request Commenting feature is enabled.sourceControlEvaluationsEnabled
+ indicates if the source control evaluations are enabled for the continuous
+ risk profile feature.sourceControlScanTarget indicates
+ the path inside the repository.sshEnabled indicates
+ if ssh is enabled.commitStatusEnabled indicates
+ if interaction with the commit statuses on the SCM system is enabled.id is the internal owner ID.repositoryUrl
+ is the http(s) and ssh urls for the application specified in the ownerId.username
+ is optional, can be provided for Bitbucket Server and Cloud.token
+ is optional,if inherited. If provided, this value will override the value
+ inherited from the root organization, organization or application level.provider
+ is the name of of the SCM system. Allowed values are azure,
+ github, gitlab, and bitbucket.baseBranch
+ is required for the root organization. Organizations and applications inherit
+ from the root unless overridden.enablePullRequests
+ has been deprecated in version 124.remediationPullRequestsEnabled
+ is optional. Set it to `true` to enable the Automated Pull Requests.enableStatusChecks
+ has been deprecated in version 124.statusChecksEnabled
+ is an internal field.pullRequestCommentingEnabled
+ is optional. Set it to `true` to enable the Pull Request Commenting feature.sourceControlEvaluationsEnabled
+ is set to `true` to enable source control evaluations for the continuous
+ risk profile feature.sourceControlScanTarget is the
+ path inside the repository.sshEnabled is set to `true`
+ to enable ssh.commitStatusEnabled is set to `true`
+ if interaction with the commit statuses on the SCM is enabled.id is the internal owner ID.repositoryUrl
+ is the http(s) and ssh urls for the application specified in the ownerId.username
+ is optional, can be provided for Bitbucket Server and Cloud.token
+ is optional if inherited. If provided, this value will override the value
+ inherited from the root organization, organization or application level.provider
+ is the name of of the SCM system. Allowed values are azure,
+ github, gitlab, and bitbucket.baseBranch
+ is required for the root organization. Organizations and applications inherit
+ from the root unless overridden.enablePullRequests
+ has been deprecated in version 124.remediationPullRequestsEnabled
+ is optional. Set it to `true` to enable the Automated Pull Requests.enableStatusChecks
+ has been deprecated in version 124.statusChecksEnabled
+ is an internal field.pullRequestCommentingEnabled
+ is optional. Set it to `true` to enable the Pull Request Commenting feature.sourceControlEvaluationsEnabled
+ is set to `true` to enable source control evaluations for the continuous
+ risk profile feature.sourceControlScanTarget is the
+ path inside the repository.sshEnabled is set to `true`
+ to enable ssh.commitStatusEnabled is set to `true`
+ if interaction with the commit statuses on the SCM is enabled.Note that IQ Server has a preset limit of purging 5000 reports in one execution of its report purging job. name: Data Retention Policies +- description: Use this REST API to export Sonatype Developer component priorities + data, including security reachability data. + name: Developer Priorities - description: "Use this REST API to perform an application policy evaluation. Policy\ \ evaluations are executed asynchronously.
This is a 2-step process that involves:\ \ \n1. Requesting a policy evaluation (POST) \n2. Checking the status and response\ \ of the evaluation request (GET)" name: Policy Evaluation +- description: 'Use this REST API to manage components that are developed in-house + and are not open-source. + + + Claiming the component stores the identity information for the component hash + and avoids triggering the Component-Unknown policy. + + + Components will have a match state as `Exact` and Identification Source as `Manual`, + + for subsequent scans or evaluations.' + name: Claim Components - description: 'Use this REST API to obtain the violation details, violation details across stages (cross stage), violations occurring due to transitive dependencies and all waivers applicable to a violation. @@ -8877,12 +9762,28 @@ tags: of stale waivers, view existing policy waivers on components, view quarantined components and retrieve additional metrics data. ' name: Reports -- name: Applications -- name: Audit Logs -- name: Claim -- name: Composite Source Control -- name: Composite Source Control Config Validator -- name: Config +- description: 'Use this REST API to manage authorizations for users or user groups. + + + You can view existing role assignments and grant or revoke user authorization + on organizations, applications and repositories.' + name: Role Memberships +- description: 'Roles provide sets of permissions that grant access to the functionality + in the user interface,through integrations, and when using REST APIs. + + + Permissions are granted by assigning users or groups to the system roles or at + the various levels in the organizational hierarchy: root organization, repository + managers, and applications and organizations. + + + Use this REST API to retrieve role IDs, role names and descriptions.' + name: Roles +- description: Use this REST API to: