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 Service IDs API

Create and manage service IDs for applications and services

IBM Service IDs 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 Service IDs. 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 7 operations across 3 paths, and defines 10 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.

7 operations 3 paths 10 schemas 2 DELETE2 GET2 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 Service IDs 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 7

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

Service IDs 7

Create and manage service IDs for applications and services

GET
/v1/serviceids/
List service IDs
listServiceIds 6 params → 200401
POST
/v1/serviceids/
Create a service ID
createServiceId body → 201400401
GET
/v1/serviceids/{id}
Get a service ID
getServiceId 3 params → 200401404
PUT
/v1/serviceids/{id}
Update a service ID
updateServiceId 2 params body → 200400404409
DELETE
/v1/serviceids/{id}
Delete a service ID
deleteServiceId 1 param → 204401404
POST
/v1/serviceids/{id}/lock
Lock a service ID
lockServiceId 1 param → 200401404
DELETE
/v1/serviceids/{id}/lock
Unlock a service ID
unlockServiceId 1 param → 200401404

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are ApiKey (17 properties), ServiceId (13 properties), ResponseContext (11 properties), CreateApiKeyRequest (9 properties). Each schema is shown below with its type and property counts.

ResponseContext
object
Context metadata for paginated API responses.
11 properties
CreateServiceIdRequest
object
Request body for creating a service ID.
5 properties 2 required
CreateApiKeyRequest
object
Request body for creating an API key.
9 properties 2 required
ApiKey
object
An IAM API key used for authentication.
17 properties
ErrorResponse
object
An error response from the IAM API.
4 properties
ServiceId
object
A service ID is an identity for an application or service that can be used to authenticate with IBM Cloud.
13 properties
ServiceIdList
object
A paginated list of service IDs.
7 properties
Activity
object
Activity information for an identity resource.
2 properties
ActivityEntry
object
A history entry for an identity resource.
6 properties
UpdateServiceIdRequest
object
Request body for updating a service ID.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ibm-service-ids-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