How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Sonatype Config SAML API

Use this REST API to manage the SAML configuration for IQ Server.

Sonatype Config SAML API is one of 58 APIs that Sonatype publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Config SAML. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and 2 JSON Schemas.

This API exposes 4 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.2.0, at version 1.201.0-02.

Requests are made against the base URL https://{iq-server-host}/.

4 operations 2 paths 2 schemas 1 DELETE2 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.201.0-02
Base URL
https://{iq-server-host}/
Authentication
HTTP Basic, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Sonatype Config SAML API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuth). It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 4

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

Config SAML 4

Use this REST API to manage the SAML configuration for IQ Server.

DELETE
/api/v2/config/saml
Use this method to delete the SAML configuration. Permissions required: Edit System Configuration and Users.
deleteSamlConfiguration → 204404
GET
/api/v2/config/saml
Use this method to inspect the SAML configuration. Permissions required: Edit System Configuration and Users
getSamlConfiguration → 200404
PUT
/api/v2/config/saml
Use this method to enable SSO using SAML. This request uses the content type multipart/form-data to transmit the configuration to IQ Server. Permissions required: Edit System Configuration and Users
insertOrUpdateSamlConfiguration body → 204400
GET
/api/v2/config/saml/metadata
Use this method to retrieve IQ Server's metadata service provider descriptor. Permissions required: Edit System Configuration and Users
getMetadata → 200404

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are ApiSamlConfigurationResponseDTO (10 properties), ApiSamlConfigurationDTO (9 properties). Each schema is shown below with its type and property counts.

ApiSamlConfigurationResponseDTO
object
10 properties
ApiSamlConfigurationDTO
object
Enter the SAML configuration identityProviderName the name of the Identity Provider that is displayed on the login page when SAML is configured. entityId is th…
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sonatype-config-saml-api-openapi.yml Raw ↑

Other APIs Sonatype publishes across the network.

Sonatype Advanced Search API
Sonatype Application Categories API
Sonatype Application Report Data API
Sonatype Applications API
Sonatype Audit Logs API
Sonatype Auto Policy Waiver Exclusions API
Sonatype Auto Policy Waivers API
Sonatype CI Configuration API
Sonatype Claim Components API
Sonatype Component Labels API
Sonatype Component Search API
Sonatype Components API
Where this information came from

This is an independent, third-party profile of Sonatype Config SAML API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.