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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Sonatype

Sonatype Roles API

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 manage roles.

Documentation Provider Profile APIs.io OpenAPI GitHub

Sonatype Roles 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 Roles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and 2 JSON Schemas.

This API exposes 6 operations across 3 paths, and defines 4 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}/.

6 operations 3 paths 4 schemas 1 DELETE3 GET1 POST1 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 Roles 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 6

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

Roles 6

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 assignin…

GET
/api/v2/roles
Use this method to view the role IDs, role names and descriptions. Permissions required: View All Roles
getRoles → 200
POST
/api/v2/roles
Use this method to create a new custom role with specified permissions. Permissions required: Edit Roles
addRole body → 200
GET
/api/v2/roles/new
Use this method to retrieve a template for creating a new custom role, including all available permissions that can be assigned. Permissions required: Edit Roles
getTemplateForNewRole → 200
DELETE
/api/v2/roles/{roleId}
Use this method to delete a custom role. Permissions required: Edit Roles
deleteRole 1 param → 204
GET
/api/v2/roles/{roleId}
Use this method to retrieve details for a specific role, including its permissions. Permissions required: View All Roles
getRoleById 1 param → 200
PUT
/api/v2/roles/{roleId}
Use this method to update an existing custom role and its permissions. Permissions required: Edit Roles
updateRole 1 param body → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are ApiRoleDTO (5 properties), ApiPermissionDTO (4 properties), ApiPermissionCategoryDTO (2 properties), ApiRoleListDTO (1 property). Each schema is shown below with its type and property counts.

ApiRoleListDTO
object
1 property
ApiRoleDTO
object
5 properties
ApiPermissionCategoryDTO
object
2 properties
ApiPermissionDTO
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sonatype-roles-api-openapi.yml Raw ↑

Other APIs Sonatype publishes across the network.

Sonatype Advanced Search API
AE Profile APIs.io
Sonatype Application Categories API
AE Profile APIs.io
Sonatype Application Report Data API
AE Profile APIs.io
Sonatype Applications API
AE Profile APIs.io
Sonatype Audit Logs API
AE Profile APIs.io
Sonatype Auto Policy Waiver Exclusions API
AE Profile APIs.io
Sonatype Auto Policy Waivers API
AE Profile APIs.io
Sonatype CI Configuration API
AE Profile APIs.io
Sonatype Claim Components API
AE Profile APIs.io
Sonatype Component Labels API
AE Profile APIs.io
Sonatype Component Search API
AE Profile APIs.io
Sonatype Components API
AE Profile APIs.io
#Roles
← Back to S APIs
API Details
ID
sonatype:sonatype-roles-api
Base URL
https://{iq-server-host}/
Docs
https://help.sonatype.com/en/iq-api-reference.html
Provider
Sonatype
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=sonatype-roles-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/sonatype-roles-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Sonatype Roles 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.