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 Trusted Profiles API

Create and manage trusted profiles for federated identities

IBM Trusted Profiles 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 Trusted Profiles. 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 8 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 8 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 Trusted Profiles 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.

Trusted Profiles 5

Create and manage trusted profiles for federated identities

GET
/v1/profiles
List trusted profiles
listProfiles 7 params → 200401
POST
/v1/profiles
Create a trusted profile
createProfile body → 201400401
GET
/v1/profiles/{profile-id}
Get a trusted profile
getProfile 2 params → 200401404
PUT
/v1/profiles/{profile-id}
Update a trusted profile
updateProfile 2 params body → 200400404409
DELETE
/v1/profiles/{profile-id}
Delete a trusted profile
deleteProfile 1 param → 204401404

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are TrustedProfile (14 properties), ResponseContext (11 properties), TrustedProfileList (7 properties), ActivityEntry (6 properties). Each schema is shown below with its type and property counts.

TrustedProfileList
object
A paginated list of trusted profiles.
7 properties
ResponseContext
object
Context metadata for paginated API responses.
11 properties
ErrorResponse
object
An error response from the IAM API.
4 properties
CreateProfileRequest
object
Request body for creating a trusted profile.
3 properties 2 required
TrustedProfile
object
A trusted profile defines a set of conditions under which federated users or compute resources can assume an identity with specific access rights.
14 properties
Activity
object
Activity information for an identity resource.
2 properties
ActivityEntry
object
A history entry for an identity resource.
6 properties
UpdateProfileRequest
object
Request body for updating a trusted profile.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ibm-trusted-profiles-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