Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

IBM Roles API

List and manage IAM roles

IBM Roles API is one of 55 APIs that IBM publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Roles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, pricing, and 1 JSON Schema.

This API exposes 5 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://iam.cloud.ibm.com.

5 operations 2 paths 5 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.us-south.assistant.watson.cloud.ibm.com
Authentication
HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 1

IBM Roles API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — IAM access token obtained from the /identity/token endpoint. Pass as Authorization: Bearer .

Paths & Operations 5

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

Roles 5

List and manage IAM roles

GET
/v2/roles
List IAM roles
listRoles 5 params → 200401
POST
/v2/roles
Create a custom role
createRole body → 201400401409
GET
/v2/roles/{role_id}
Get a role
getRole 1 param → 200401404
PUT
/v2/roles/{role_id}
Replace a custom role
replaceRole 2 params body → 200400404409
DELETE
/v2/roles/{role_id}
Delete a custom role
deleteRole 1 param → 204401404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Role (12 properties), ResponseContext (11 properties), CreateRoleRequest (6 properties), ErrorResponse (4 properties). Each schema is shown below with its type and property counts.

RoleList
object
A list of IAM roles.
3 properties
Role
object
An IAM role that defines a set of actions.
12 properties
ResponseContext
object
Context metadata for paginated API responses.
11 properties
ErrorResponse
object
An error response from the IAM API.
4 properties
CreateRoleRequest
object
Request body for creating a custom role.
6 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ibm-roles-api-openapi.yml Raw ↑

Other APIs IBM publishes across the network.

IBM Cloud Object Storage
IBM Cloud Databases for PostgreSQL
IBM Cloud Code Engine
IBM watsonx.ai
IBM watsonx.governance
IBM Watson Discovery
IBM Cloud Virtual Private Cloud
IBM Cloud Kubernetes Service
IBM Key Protect
IBM Cloud Secrets Manager
IBM Cloud Event Notifications
IBM Cloud Container Registry