# Sonatype Roles API

**Canonical:** https://apis.io/apis/sonatype/sonatype-roles-api/  
**Provider:** Sonatype — https://apis.io/providers/sonatype/  
**Base URL:** https://{iq-server-host}/  
**Documentation:** https://help.sonatype.com/en/iq-api-reference.html

Sonatype Roles API is one of 58 APIs that [Sonatype](https://apis.io/providers/sonatype/) publishes on the [APIs.io](https://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.

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.

## Machine-readable artifacts (5)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/openapi/sonatype-roles-api-openapi.yml
- **Documentation** — https://help.sonatype.com/en/iq-api-reference.html
- **Reference** — https://help.sonatype.com/en/rest-apis.html
- **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 Sonatype APIs (12)

- [Sonatype Advanced Search API](https://apis.io/apis/sonatype/sonatype-advanced-search-api/)
- [Sonatype Application Categories API](https://apis.io/apis/sonatype/sonatype-application-categories-api/)
- [Sonatype Application Report Data API](https://apis.io/apis/sonatype/sonatype-application-report-data-api/)
- [Sonatype Applications API](https://apis.io/apis/sonatype/sonatype-applications-api/)
- [Sonatype Audit Logs API](https://apis.io/apis/sonatype/sonatype-audit-logs-api/)
- [Sonatype Auto Policy Waiver Exclusions API](https://apis.io/apis/sonatype/sonatype-auto-policy-waiver-exclusions-api/)
- [Sonatype Auto Policy Waivers API](https://apis.io/apis/sonatype/sonatype-auto-policy-waivers-api/)
- [Sonatype CI Configuration API](https://apis.io/apis/sonatype/sonatype-ci-configuration-api/)
- [Sonatype Claim Components API](https://apis.io/apis/sonatype/sonatype-claim-components-api/)
- [Sonatype Component Labels API](https://apis.io/apis/sonatype/sonatype-component-labels-api/)
- [Sonatype Component Search API](https://apis.io/apis/sonatype/sonatype-component-search-api/)
- [Sonatype Components API](https://apis.io/apis/sonatype/sonatype-components-api/)

## Tags

Roles

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/sonatype/sonatype-roles-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/sonatype/.