Sonatype

Sonatype Config OIDC API

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

GitHub OpenAPI

Operations 3

DELETE /api/v2/config/oidc #
GET /api/v2/config/oidc #
PUT /api/v2/config/oidc #

Documentation

📖
Documentation
https://help.sonatype.com/en/iq-api-reference.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/openapi/sonatype-config-oidc-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-application-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-policy-violation-schema.json

Other Resources

🔗
Reference
https://help.sonatype.com/en/rest-apis.html

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/sonatype-config-oidc-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

sonatype-config-oidc-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Sonatype Lifecycle Public REST Advanced Search Config OIDC API
  version: 1.201.0-02
  description: Use the Advanced Search REST API to perform searches on Lifecycle application scan reports.
security:
- BasicAuth: []
  BearerAuth: []
tags:
- description: Use this REST API to manage the OIDC configuration for IQ Server.
  name: Config OIDC
paths:
  /api/v2/config/oidc:
    delete:
      description: 'Use this method to delete the OIDC configuration.


        Permissions required: Edit System Configuration and Users'
      operationId: deleteOidcConfiguration
      responses:
        '404':
          description: OIDC is not configured.
      tags:
      - Config OIDC
    get:
      description: 'Use this method to retrieve the OIDC configuration.


        Permissions required: Edit System Configuration and Users'
      operationId: getOidcConfiguration
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SsoConfigurationDTO'
          description: "The response contains:\n - `oidcConfiguration` field that contains all the oidc configuration data \n - `oAuth2Configuration` field that contains the OAuth2 configuration required for oidc"
        '404':
          description: OIDC is not configured.
      tags:
      - Config OIDC
    put:
      description: 'Use this method to enable SSO using OpenID Connect (OIDC). This request uses the content type application/json to transmit the configuration to IQ Server.


        Permissions required: Edit System Configuration and Users'
      operationId: insertOrUpdateOidcConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SsoConfigurationDTO'
      responses:
        '204':
          description: Configuration successful.
        '400':
          description: Invalid configuration.
      tags:
      - Config OIDC
components:
  schemas:
    SsoConfigurationDTO:
      properties:
        oauth2Configuration:
          $ref: '#/components/schemas/OAuth2ConfigurationDTO'
        oidcConfiguration:
          $ref: '#/components/schemas/OidcConfigurationDTO'
      type: object
    OAuth2ConfigurationDTO:
      properties:
        emailClaim:
          type: string
        exactMatchClaimsJson:
          type: string
        firstNameClaim:
          type: string
        groupsClaim:
          type: string
        idpIssuer:
          type: string
        idpJwks:
          type: string
        idpJwksUrl:
          type: string
        idpJwsAlgorithm:
          type: string
        lastNameClaim:
          type: string
        usernameClaim:
          type: string
      type: object
    OidcConfigurationDTO:
      properties:
        authorizationCustomParamsJson:
          type: string
        clientId:
          type: string
        clientSecret:
          type: string
        idpAuthorizationUrl:
          type: string
        idpIssuer:
          type: string
        idpTokenUrl:
          type: string
        tokenRequestCustomParamsJson:
          type: string
      type: object
  securitySchemes:
    BasicAuth:
      scheme: basic
      type: http
    BearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http