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 Policies API

Create and manage IAM access policies

IBM Policies 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 Policies. 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 6 operations across 2 paths, and defines 9 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.

6 operations 2 paths 9 schemas 1 DELETE2 GET1 PATCH1 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 Policies 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 6

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

Policies 6

Create and manage IAM access policies

GET
/v1/policies
List access policies
listPolicies 8 params → 200401
POST
/v1/policies
Create an access policy
createPolicy body → 201400401409
GET
/v1/policies/{policy_id}
Get an access policy
getPolicy 1 param → 200401404
PUT
/v1/policies/{policy_id}
Replace an access policy
replacePolicy 2 params body → 200400404409
DELETE
/v1/policies/{policy_id}
Delete an access policy
deletePolicy 1 param → 204401404
PATCH
/v1/policies/{policy_id}
Update policy state
updatePolicyState 2 params body → 200400404409

Schemas 9

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

PolicySubject
object
A subject in a policy, defining who the policy applies to.
1 property
ResponseContext
object
Context metadata for paginated API responses.
11 properties
CreatePolicyRequest
object
Request body for creating an access policy.
5 properties 4 required
PolicyList
object
A paginated list of access policies.
1 property
ErrorResponse
object
An error response from the IAM API.
4 properties
PolicyRole
object
A role assigned in a policy.
3 properties
PolicyResource
object
A resource in a policy, defining what the policy applies to.
1 property
PolicyAttribute
object
An attribute used to identify a subject or resource in a policy.
3 properties 2 required
Policy
object
An IAM access policy that grants a subject a set of roles on a resource.
12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ibm-policies-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