Sonatype

Sonatype Config Crowd API

Use this REST API to manage the configuration of an existing Atlassian Crowd Server that is being used to authenticate users for IQ Server.

GitHub OpenAPI

Operations 4

DELETE /api/v2/config/crowd #
GET /api/v2/config/crowd #
PUT /api/v2/config/crowd #
POST /api/v2/config/crowd/test #

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-crowd-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-crowd-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-crowd-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Sonatype Lifecycle Public REST Advanced Search Config Crowd 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 configuration of an existing Atlassian Crowd Server that is being used to authenticate users for IQ Server.
  name: Config Crowd
paths:
  /api/v2/config/crowd:
    delete:
      description: 'Use this method to remove an existing Atlassian Crowd Configuration.


        Permissions required: Edit System Configuration and Users'
      operationId: deleteCrowdConfiguration
      responses:
        '204':
          description: The Atlassian Crowd Server configuration has been deleted.
      tags:
      - Config Crowd
    get:
      description: 'Use this method to retrieve the configuration details for the Atlassian Crowd Server.


        Permissions required: Edit System Configuration and Users'
      operationId: getCrowdConfiguration
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiCrowdConfigurationDTO'
          description: The response contains the `serverUrl` and `applicationName` provided at the time of setting up the Crowd Server.
      tags:
      - Config Crowd
    put:
      description: 'Use this method to create a new or update an existing Atlassian Crowd Server configuration.


        Permissions required: Edit System Configuration and Users'
      operationId: insertOrUpdateCrowdConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiCrowdConfigurationDTO'
        description: 'The request JSON should include the `serverUrl`, `applicationName`, and the `applicationPassword` which will be used for authentication against the Atlassian Crowd Server.


          If updating the `serverUrl`, the `applicationPassword` field is required.'
      responses:
        '204':
          description: Update or create successful
      tags:
      - Config Crowd
  /api/v2/config/crowd/test:
    post:
      description: Use this method to test a new or an existing Atlassian Crowd Server configuration.
      operationId: testCrowdConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiCrowdConfigurationDTO'
        description: 'To test an existing configuration, the request body is not required.


          To test a new configuration, provide the `serverURl`, `applicationName`, and `applicationPassword` for the configuration.'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiStatusDTO'
          description: Test performed, results will be in the response message string.
      tags:
      - Config Crowd
components:
  schemas:
    ApiStatusDTO:
      properties:
        code:
          format: int32
          type: integer
        message:
          type: string
      type: object
    ApiCrowdConfigurationDTO:
      properties:
        applicationName:
          type: string
        applicationPassword:
          type: string
        serverUrl:
          type: string
      type: object
  securitySchemes:
    BasicAuth:
      scheme: basic
      type: http
    BearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http