Is Docs Wso2 WSO2 Identity Server Claim Management API

Name: WSO2 Identity Server Claim Management API
Brand: WSO2 Identity Server Claim Management API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentIdentity AuthDirectory Servicesoauth2, basic18 EndpointsREST

For Agents

Install Jentic One Beta

Connect the WSO2 Identity Server Claim Management API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the WSO2 Identity Server Claim Management API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with WSO2 Identity Server Claim Management API.

Define new local claims with display names, descriptions, and attribute mappings against the local dialect

Group external claim definitions under custom claim dialects for federated identity flows

Import a complete claim dialect from a file to bootstrap a new WSO2 tenant configuration

GET STARTED

Start building with WSO2 Identity Server Claim Management API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI specification for WSO2 Identity Server Claim Management API, keeping it validated and agent-ready. The API administers claim metadata in WSO2 Identity Server, covering local claims, claim dialects, and external claims mapped into those dialects. It exposes 18 endpoints for retrieving, creating, updating, and removing claim definitions, plus dedicated import and export operations for transferring claim dialects between tenants. Multi-tenant routing is built into the base URL so administrators can manage claim configurations on a per-tenant basis.

Use Cases

Patterns agents use WSO2 Identity Server Claim Management API for, with concrete tasks.

★ Tenant bootstrap with custom claim schema

Provision a new WSO2 Identity Server tenant with a tailored set of claims and dialects rather than relying on the defaults. Administrators import a curated claim dialect file via POST /claim-dialects/import, then add tenant-specific local claims through POST /claim-dialects/local/claims. The full bootstrap finishes in minutes instead of hours of manual UI configuration.

Import the file enterprise-claims.json as a new claim dialect, then create a local claim 'employeeID' mapped to the http://wso2.org/claims/employeeId URI

Federated identity claim mapping

Map claims from an external identity provider — for example SAML or OIDC — into the WSO2 dialect system so downstream applications receive consistent attribute names. The agent registers a new claim dialect for the IdP and pushes external claim mappings via POST /claim-dialects/{dialect-id}/claims, linking each external claim to a local claim URI for transparent translation.

Create a new claim dialect for https://login.example.com and add an external claim mapping from urn:example:role to http://wso2.org/claims/role

Claim configuration migration between environments

Export the claim dialect configuration from a staging tenant and re-import it into production to keep environments in sync. Use GET /claim-dialects/{dialect-id}/export to retrieve the dialect definition, then POST /claim-dialects/import on the target server to apply it. Avoids drift between environments and supports change-controlled releases of identity configuration.

Export claim dialect with id 'aHR0cDovL3dzbzIub3JnL29pZGM' from staging and import it to the production server

AI agent identity attribute discovery

An AI agent integrating with WSO2 needs to know which user attributes are available before requesting tokens or building consent screens. Through Jentic the agent calls the GET /claim-dialects/local/claims operation, parses the returned attribute URIs, and uses them to construct OIDC scope requests with confidence that each claim exists on the tenant. This removes guesswork from cross-system identity flows.

Retrieve all local claims and select those with the dialect URI http://wso2.org/oidc/claim to construct an OIDC scope list

Key Endpoints

18 endpoints — jentic publishes the only available openapi specification for wso2 identity server claim management api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

GET

/claim-dialects/local/claims

Retrieve all local claims on the tenant

POST

/claim-dialects/local/claims

Add a new local claim

GET

/claim-dialects

List every claim dialect

POST

/claim-dialects

POST

/claim-dialects/import

Import a claim dialect from a file

GET

/claim-dialects/{dialect-id}/export

Export a claim dialect for migration

POST

/claim-dialects/{dialect-id}/claims

Add an external claim under a dialect

GET

/claim-dialects/local/claims

Retrieve all local claims on the tenant

POST

/claim-dialects/local/claims

Add a new local claim

GET

/claim-dialects

List every claim dialect

POST

/claim-dialects

POST

/claim-dialects/import

Import a claim dialect from a file

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

WSO2 Identity Server OAuth2 client credentials and any basic auth secrets are encrypted in the Jentic vault. Agents receive scoped tokens at execution time — raw client secrets never enter the agent context.

Intent-based discovery

Agents search by intent (e.g. 'import a WSO2 claim dialect' or 'list local claims') and Jentic returns the matching operation with its full input schema, removing the need to read the WSO2 docs site by hand.

Time to first call

Direct WSO2 Claim Management integration takes 1-2 days to wire OAuth2 token flow, multipart import handling, and tenant URL templating. Through Jentic: under 1 hour — search, load schema, execute.

FAQs

Specific to using WSO2 Identity Server Claim Management API through Jentic.

Why is there no official OpenAPI spec for WSO2 Identity Server Claim Management API?

WSO2 does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call WSO2 Identity Server Claim Management API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the WSO2 Claim Management API use?

The spec declares two security schemes: OAuth2 and HTTP Basic. Production deployments typically issue OAuth2 access tokens through the Identity Server's own token endpoint and pass them as Authorization: Bearer headers. Through Jentic, both credential styles are stored encrypted in the vault and never enter the agent context.

Can I import an entire claim dialect from a file with this API?

Yes. POST /claim-dialects/import accepts a multipart upload of a dialect file and registers every claim it contains in one request. PUT /claim-dialects/import performs the same operation in update mode against an existing dialect.

What are the rate limits for the WSO2 Claim Management API?

The spec does not declare rate limits — they are governed by the deployment's gateway throttling policy. Self-hosted WSO2 administrators set per-tenant request quotas in the Identity Server configuration. Validate the limit for your environment before scripting bulk claim updates.

How do I discover all local claims on a tenant through Jentic?

Search Jentic with the query 'list all claim dialects' or 'retrieve local claims', load the GET /claim-dialects/local/claims operation, and execute it with the tenant base URL. The response is an array of claim objects with claim URI, display name, and attribute mapping.

Does this API expose user records or just claim definitions?

Only claim definitions and dialects. It is the schema layer of WSO2 Identity Server — actual user records, authentication, and consent flows live in separate WSO2 SCIM and OAuth2 endpoints.

Is Docs Wso2 WSO2 Identity Server Claim Management API

Connect the WSO2 Identity Server Claim Management API to your agent

Capabilities

Start building with WSO2 Identity Server Claim Management API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs