82 lines
2.0 KiB
Markdown
82 lines
2.0 KiB
Markdown
---
|
|
name: sso-routes
|
|
description: Handle 6 OpenAPI operation(s) under /sso for the sso route group.
|
|
---
|
|
|
|
# sso API Routes
|
|
|
|
Handle 6 OpenAPI operation(s) under /sso for the sso route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### sso_controller_authorize
|
|
|
|
- Operation ID: `sso_controller_authorize`
|
|
- Route: `GET /sso/authorize`
|
|
- Mode: READ
|
|
- Summary: Initiate SSO
|
|
- Parameters:
|
|
- `provider_scopes` in `query`
|
|
- `provider_query_params` in `query`
|
|
- `client_id` in `query` required
|
|
- `domain` in `query`
|
|
- `provider` in `query`
|
|
- `redirect_uri` in `query` required
|
|
- `response_type` in `query` required
|
|
- `state` in `query`
|
|
- `connection` in `query`
|
|
- `organization` in `query`
|
|
- `domain_hint` in `query`
|
|
- `login_hint` in `query`
|
|
- `nonce` in `query`
|
|
|
|
### sso_controller_json_web_key_set
|
|
|
|
- Operation ID: `sso_controller_json_web_key_set`
|
|
- Route: `GET /sso/jwks/{clientId}`
|
|
- Mode: READ
|
|
- Summary: Get JWKS
|
|
- Parameters:
|
|
- `clientId` in `path` required
|
|
|
|
### sso_controller_logout
|
|
|
|
- Operation ID: `sso_controller_logout`
|
|
- Route: `GET /sso/logout`
|
|
- Mode: READ
|
|
- Summary: Logout Redirect
|
|
- Parameters:
|
|
- `token` in `query` required
|
|
|
|
### sso_controller_logout_authorize
|
|
|
|
- Operation ID: `sso_controller_logout_authorize`
|
|
- Route: `POST /sso/logout/authorize`
|
|
- Mode: WRITE
|
|
- Summary: Logout Authorize
|
|
- Body: JSON request body accepted.
|
|
|
|
### sso_controller_get_profile
|
|
|
|
- Operation ID: `sso_controller_get_profile`
|
|
- Route: `GET /sso/profile`
|
|
- Mode: READ
|
|
- Summary: Get a User Profile
|
|
|
|
### sso_controller_token
|
|
|
|
- Operation ID: `sso_controller_token`
|
|
- Route: `POST /sso/token`
|
|
- Mode: WRITE
|
|
- Summary: Get a Profile and Token
|
|
- Parameters:
|
|
- `client_id` in `query` required
|
|
- `client_secret` in `query` required
|
|
- `code` in `query` required
|
|
- `grant_type` in `query` required
|
|
- Body: JSON request body accepted.
|