Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

WSO2 Artifact Compliance API

for accessing artifact compliance.

WSO2 Artifact Compliance API is one of 90 APIs that WSO2 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Artifact Compliance. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 4 paths, and defines 13 schemas. It is described by OpenAPI 3.0.1, at version v4.

Requests are made against a single base URL, https://apis.wso2.com/api/am/admin/v4.

4 operations 4 paths 13 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
v4
Base URL
https://apis.wso2.com
Authentication
OAuth 2.0
Contact
License
Resource Areas
1

Authentication & Security 1

WSO2 Artifact Compliance API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2Security) using the password flow, exposing 41 scopes.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

Artifact Compliance 4

for accessing artifact compliance.

GET
/artifact-compliance/api
Retrieves compliance of all API artifacts
getComplianceStatusListOfAPIs 2 params → 200400401403500
GET
/artifact-compliance/api/summary
Retrieves the summary of compliance of all API artifacts
getComplianceSummaryForAPIs → 200400401403500
GET
/artifact-compliance/api/{apiId}
Retrieve compliance details for a specific API
getComplianceByAPIId 1 param → 200400401403500
GET
/artifact-compliance/api/{apiId}/ruleset-validation-results/{rulesetId}
Retrieve ruleset validation results for a specific API
getRulesetValidationResultsByAPIId 2 params → 200400401403500

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are RuleValidationResult (7 properties), RulesetValidationResult (5 properties), ArtifactComplianceStatus (5 properties), ArtifactInfo (5 properties). Each schema is shown below with its type and property counts.

ArtifactComplianceList
object
Compliance status of a list of artifacts.
3 properties
ArtifactComplianceSummary
object
Summary of compliance of certain artifact in the organization.
5 properties
ArtifactInfo
object
Detailed information about an artifact.
5 properties
RulesetValidationResultWithoutRules
object
Result of the ruleset validation.
4 properties
ArtifactComplianceStatus
object
Provides compliance status of an artifact.
5 properties
PolicyAdherenceSummary
object
Summary of governance policy adherence in the organization.
4 properties
Pagination
object
5 properties
PolicyAdherenceWithRulesets
object
Adherence status of a policy with ruleset details.
4 properties
SeverityBasedRuleViolationCount
object
List of rules violated by the artifact under each severity.
2 properties
Error
object
3 properties 2 required
ArtifactComplianceDetails
object
Provides compliance details of an artifact.
4 properties
RulesetValidationResult
object
Result of the ruleset validation.
5 properties
RuleValidationResult
object
Result of the rule validation.
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wso2-artifact-compliance-api-openapi.yml Raw ↑

Other APIs WSO2 publishes across the network.

WSO2 Advanced Policy (Collection) API
WSO2 Advanced Policy (Individual) API
WSO2 AIServiceProvider API
WSO2 AIServiceProviders API
WSO2 Alert Subscriptions API
WSO2 Alerts API
WSO2 Api Artifact API
WSO2 API Categories API
WSO2 API Category (Collection) API
WSO2 API Category (Individual) API
WSO2 API Chat API
WSO2 API Documents API