Agent-ready OpenAPI document · curated by JenticIdentity AuthAuthenticationapiKey3 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Run the OAuth 2.0 device authorisation flow with IAM Identity Center to obtain a bearer access token. Agents register a client, start device authorisation, and exchange the code for a token.
Use for: I need to register my CLI as an IAM Identity Center OIDC client, Start the device authorisation flow for a user signing in, Exchange a device code for an access token, Get a bearer token that I can use against the SSO Portal
Not supported: Does not list accounts, fetch role credentials, or manage user directories - use only for the OAuth device authorisation handshake that produces an IAM Identity Center bearer token.
Jentic publishes the only available OpenAPI specification for AWS SSO OIDC, keeping it validated and agent-ready. AWS IAM Identity Center OIDC implements the OAuth 2.0 Device Authorization Grant flow so that CLIs and native applications can sign users into IAM Identity Center without an embedded browser. The three operations let a tool register itself as an OIDC client, start a device authorisation, and exchange the resulting device code for an access token. The issued bearer token is then consumed by the IAM Identity Center Portal to list accounts and roles.
Install Jentic One Beta
Connect the AWS SSO OIDC to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the AWS SSO OIDC, 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.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Famazonaws.com%2Faws-sso-oidc" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Famazonaws.com%2Faws-sso-oidc" | sh
jentic register # connects your agent to your Jentic One instanceJentic 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 AWS SSO OIDC API.
Register a new public OIDC client with RegisterClient and receive clientId and clientSecret
Start a device authorisation flow with StartDeviceAuthorization and receive a verification URL plus device code
Exchange a verified device code for an access token via CreateToken
Return refresh and access tokens scoped to IAM Identity Center
Use Cases
Patterns agents use AWS SSO OIDC API for, with concrete tasks.
★ CLI Sign-In via Device Authorisation
Command-line tools and developer utilities use the OIDC device flow to sign users into IAM Identity Center without launching a browser inside the terminal. RegisterClient registers the tool once, StartDeviceAuthorization returns a userCode and verificationUriComplete that the user opens in a browser, and CreateToken polls until approval, then returns the access token.
RegisterClient with clientName='my-cli' and clientType='public', call StartDeviceAuthorization to get verificationUriComplete and deviceCode, then poll CreateToken with grantType='urn:ietf:params:oauth:grant-type:device_code' until accessToken is returned.
Native Application Single Sign-On
Desktop tools that operate against many AWS accounts use the OIDC device flow as their authentication primitive: one sign-in produces an access token, the tool then uses ListAccounts and GetRoleCredentials to surface a role picker, and the resulting sigv4 credentials sign every other AWS call.
RegisterClient for the native app, run StartDeviceAuthorization, and once the user approves call CreateToken to obtain the bearer token to feed into the SSO Portal API.
Token Refresh Loop
IAM Identity Center access tokens expire after a configured lifetime. Tools call CreateToken with grantType='refresh_token' and the previously-issued refreshToken to obtain a new access token without re-prompting the user, until the refresh token itself expires.
Call CreateToken with grantType='refresh_token' and the cached refreshToken; if the response is a TokenError, fall back to a new device authorisation flow.
AI Agent Federated Sign-In via Jentic
AI agents using Jentic that operate on behalf of an IAM Identity Center user can run the device flow once at setup and let Jentic handle all subsequent token exchange. The user sees the device code, approves it in a browser, and the resulting bearer token lives in your Jentic One instance - never in the agent's prompt.
Search Jentic for 'start aws sso device authorization', execute StartDeviceAuthorization with the registered clientId and clientSecret, surface the verificationUriComplete to the user, then poll CreateToken until the access token is returned.
Key Endpoints
3 endpoints — jentic publishes the only available openapi specification for aws sso oidc, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
POST
/client/register
Register a public OIDC client (RegisterClient)
POST
/device_authorization
Start a device authorisation flow (StartDeviceAuthorization)
POST
/token
Exchange a device code or refresh token for an access token (CreateToken)
POST
/client/register
Register a public OIDC client (RegisterClient)
POST
/device_authorization
Start a device authorisation flow (StartDeviceAuthorization)
POST
/token
Exchange a device code or refresh token for an access token (CreateToken)
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
A
AWS SSO OIDC
- AI-Aware (B-)61/100
100
Foundational Compliance63
Developer Experience & Jentic Compatibility37
AI-Readiness & Agent Experience94
Agent Usability50
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
100
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A+Signals: 4
98%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
100%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
63
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: B-Signals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
50%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
37
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: FSignals: 4
48%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
0%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
50
Security
Trust, risk posture, and security compliance.
Grade: C-Signals: 1
50%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring AWS SSO OIDC by hand means computing SigV4 signatures, picking the right regional oidc host, and sequencing the device-authorisation handshake yourself. Through Jentic you install once, import SSO OIDC from the API Directory, store the client credentials once, and your agent calls it.
Permission scoping
SSO OIDC exposes only the handshake endpoints /client/register, /device_authorization, and /token, so scope the agent to the operations it needs. You choose which of these it may call, so it runs only the steps you allow in the device flow.
Credential isolation
Your registered client id, client secret, and issued tokens are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'start the AWS SSO device flow' or 'exchange a device code for a token', and Jentic returns the matching SSO OIDC operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using AWS SSO OIDC API through Jentic.
Why is there no official OpenAPI spec for AWS SSO OIDC?
AWS does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call AWS SSO OIDC via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.
What authentication does the AWS SSO OIDC use?
RegisterClient and StartDeviceAuthorization are unauthenticated calls (the regional endpoint is open). CreateToken authenticates the registered client via clientId and clientSecret returned at registration. The resulting bearer token is then used against the SSO Portal API. Through Jentic, the clientId, clientSecret, and resulting tokens are stored encrypted in the vault.
Can I use SSO OIDC for browser-based single sign-on?
AWS SSO OIDC currently implements only the OAuth 2.0 Device Authorization Grant flow (RFC 8628), which is designed for CLIs and native applications. Authorization Code with PKCE is not yet exposed through this API - for browser-based login, use the IAM Identity Center sign-in URLs directly.
What are the rate limits for the AWS SSO OIDC?
AWS does not publish fixed per-second limits for sso-oidc. CreateToken returns a SlowDown error when the client polls too frequently before user approval - the StartDeviceAuthorization response includes an interval (typically 5 seconds) that the client must respect.
How do I run the device authorisation flow through Jentic?
Through Jentic, RegisterClient once with clientType='public', then StartDeviceAuthorization to obtain verificationUriComplete and deviceCode, surface that URL to the user, and poll CreateToken (grantType='urn:ietf:params:oauth:grant-type:device_code') at the returned interval until accessToken is issued. Jentic stores the resulting tokens in the vault.
Is the AWS SSO OIDC free?
IAM Identity Center, including its OIDC endpoints, is offered at no additional charge. You pay only for the underlying AWS resources accessed through the federated roles.
Can I limit what my agent is allowed to do with the AWS SSO OIDC API?
Yes. AWS SSO OIDC exposes only three handshake operations, RegisterClient, StartDeviceAuthorization, and CreateToken, and because you run Jentic One yourself, your own rules decide which of those the agent may call. You can allow just StartDeviceAuthorization and CreateToken so the agent completes an existing device flow without ever registering new clients, or restrict it to token refresh alone. The client id, client secret, and issued tokens are held by your Jentic One instance and injected at execution, so the agent runs only the steps you permit.
GET STARTED