280 lines
7.4 KiB
Markdown
280 lines
7.4 KiB
Markdown
---
|
|
name: idps-routes
|
|
description: Handle 27 OpenAPI operation(s) under /api/v1/idps for the idps route group.
|
|
---
|
|
|
|
# idps API Routes
|
|
|
|
Handle 27 OpenAPI operation(s) under /api/v1/idps for the idps 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
|
|
|
|
### list_identity_providers
|
|
|
|
- Operation ID: `list_identity_providers`
|
|
- Route: `GET /api/v1/idps`
|
|
- Mode: READ
|
|
- Summary: List all IdPs
|
|
- Parameters:
|
|
- `q` in `query`
|
|
- `after` in `query`
|
|
- `limit` in `query`
|
|
- `type` in `query`
|
|
|
|
### create_identity_provider
|
|
|
|
- Operation ID: `create_identity_provider`
|
|
- Route: `POST /api/v1/idps`
|
|
- Mode: WRITE
|
|
- Summary: Create an IdP
|
|
- Body: JSON request body accepted.
|
|
|
|
### list_identity_provider_keys
|
|
|
|
- Operation ID: `list_identity_provider_keys`
|
|
- Route: `GET /api/v1/idps/credentials/keys`
|
|
- Mode: READ
|
|
- Summary: List all IdP key credentials
|
|
- Parameters:
|
|
- `after` in `query`
|
|
- `limit` in `query`
|
|
|
|
### create_identity_provider_key
|
|
|
|
- Operation ID: `create_identity_provider_key`
|
|
- Route: `POST /api/v1/idps/credentials/keys`
|
|
- Mode: WRITE
|
|
- Summary: Create an IdP key credential
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_identity_provider_key
|
|
|
|
- Operation ID: `get_identity_provider_key`
|
|
- Route: `GET /api/v1/idps/credentials/keys/{kid}`
|
|
- Mode: READ
|
|
- Summary: Retrieve an IdP key credential
|
|
- Parameters:
|
|
- `kid` in `path` required
|
|
|
|
### replace_identity_provider_key
|
|
|
|
- Operation ID: `replace_identity_provider_key`
|
|
- Route: `PUT /api/v1/idps/credentials/keys/{kid}`
|
|
- Mode: WRITE
|
|
- Summary: Replace an IdP key credential
|
|
- Parameters:
|
|
- `kid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_identity_provider_key
|
|
|
|
- Operation ID: `delete_identity_provider_key`
|
|
- Route: `DELETE /api/v1/idps/credentials/keys/{kid}`
|
|
- Mode: WRITE
|
|
- Summary: Delete an IdP key credential
|
|
- Parameters:
|
|
- `kid` in `path` required
|
|
|
|
### get_identity_provider
|
|
|
|
- Operation ID: `get_identity_provider`
|
|
- Route: `GET /api/v1/idps/{idpId}`
|
|
- Mode: READ
|
|
- Summary: Retrieve an IdP
|
|
- Parameters:
|
|
- `idpId` in `path` required
|
|
|
|
### replace_identity_provider
|
|
|
|
- Operation ID: `replace_identity_provider`
|
|
- Route: `PUT /api/v1/idps/{idpId}`
|
|
- Mode: WRITE
|
|
- Summary: Replace an IdP
|
|
- Parameters:
|
|
- `idpId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_identity_provider
|
|
|
|
- Operation ID: `delete_identity_provider`
|
|
- Route: `DELETE /api/v1/idps/{idpId}`
|
|
- Mode: WRITE
|
|
- Summary: Delete an IdP
|
|
- Parameters:
|
|
- `idpId` in `path` required
|
|
|
|
### list_csrs_for_identity_provider
|
|
|
|
- Operation ID: `list_csrs_for_identity_provider`
|
|
- Route: `GET /api/v1/idps/{idpId}/credentials/csrs`
|
|
- Mode: READ
|
|
- Summary: List all certificate signing requests
|
|
- Parameters:
|
|
- `idpId` in `path` required
|
|
|
|
### generate_csr_for_identity_provider
|
|
|
|
- Operation ID: `generate_csr_for_identity_provider`
|
|
- Route: `POST /api/v1/idps/{idpId}/credentials/csrs`
|
|
- Mode: WRITE
|
|
- Summary: Generate a certificate signing request
|
|
- Parameters:
|
|
- `idpId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_csr_for_identity_provider
|
|
|
|
- Operation ID: `get_csr_for_identity_provider`
|
|
- Route: `GET /api/v1/idps/{idpId}/credentials/csrs/{idpCsrId}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a certificate signing request
|
|
- Parameters:
|
|
- `idpId` in `path` required
|
|
- `idpCsrId` in `path` required
|
|
|
|
### revoke_csr_for_identity_provider
|
|
|
|
- Operation ID: `revoke_csr_for_identity_provider`
|
|
- Route: `DELETE /api/v1/idps/{idpId}/credentials/csrs/{idpCsrId}`
|
|
- Mode: WRITE
|
|
- Summary: Revoke a certificate signing request
|
|
- Parameters:
|
|
- `idpId` in `path` required
|
|
- `idpCsrId` in `path` required
|
|
|
|
### publish_csr_for_identity_provider
|
|
|
|
- Operation ID: `publish_csr_for_identity_provider`
|
|
- Route: `POST /api/v1/idps/{idpId}/credentials/csrs/{idpCsrId}/lifecycle/publish`
|
|
- Mode: WRITE
|
|
- Summary: Publish a certificate signing request
|
|
- Parameters:
|
|
- `idpId` in `path` required
|
|
- `idpCsrId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### list_identity_provider_signing_keys
|
|
|
|
- Operation ID: `list_identity_provider_signing_keys`
|
|
- Route: `GET /api/v1/idps/{idpId}/credentials/keys`
|
|
- Mode: READ
|
|
- Summary: List all signing key credentials for IdP
|
|
- Parameters:
|
|
- `idpId` in `path` required
|
|
|
|
### list_active_identity_provider_signing_key
|
|
|
|
- Operation ID: `list_active_identity_provider_signing_key`
|
|
- Route: `GET /api/v1/idps/{idpId}/credentials/keys/active`
|
|
- Mode: READ
|
|
- Summary: List the active signing key credential for IdP
|
|
- Parameters:
|
|
- `idpId` in `path` required
|
|
|
|
### generate_identity_provider_signing_key
|
|
|
|
- Operation ID: `generate_identity_provider_signing_key`
|
|
- Route: `POST /api/v1/idps/{idpId}/credentials/keys/generate`
|
|
- Mode: WRITE
|
|
- Summary: Generate a new signing key credential for IdP
|
|
- Parameters:
|
|
- `idpId` in `path` required
|
|
- `validityYears` in `query` required
|
|
|
|
### get_identity_provider_signing_key
|
|
|
|
- Operation ID: `get_identity_provider_signing_key`
|
|
- Route: `GET /api/v1/idps/{idpId}/credentials/keys/{kid}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a signing key credential for IdP
|
|
- Parameters:
|
|
- `idpId` in `path` required
|
|
- `kid` in `path` required
|
|
|
|
### clone_identity_provider_key
|
|
|
|
- Operation ID: `clone_identity_provider_key`
|
|
- Route: `POST /api/v1/idps/{idpId}/credentials/keys/{kid}/clone`
|
|
- Mode: WRITE
|
|
- Summary: Clone a signing key credential for IdP
|
|
- Parameters:
|
|
- `idpId` in `path` required
|
|
- `kid` in `path` required
|
|
- `targetIdpId` in `query` required
|
|
|
|
### activate_identity_provider
|
|
|
|
- Operation ID: `activate_identity_provider`
|
|
- Route: `POST /api/v1/idps/{idpId}/lifecycle/activate`
|
|
- Mode: WRITE
|
|
- Summary: Activate an IdP
|
|
- Parameters:
|
|
- `idpId` in `path` required
|
|
|
|
### deactivate_identity_provider
|
|
|
|
- Operation ID: `deactivate_identity_provider`
|
|
- Route: `POST /api/v1/idps/{idpId}/lifecycle/deactivate`
|
|
- Mode: WRITE
|
|
- Summary: Deactivate an IdP
|
|
- Parameters:
|
|
- `idpId` in `path` required
|
|
|
|
### list_identity_provider_application_users
|
|
|
|
- Operation ID: `list_identity_provider_application_users`
|
|
- Route: `GET /api/v1/idps/{idpId}/users`
|
|
- Mode: READ
|
|
- Summary: List all users for IdP
|
|
- Parameters:
|
|
- `idpId` in `path` required
|
|
- `q` in `query`
|
|
- `after` in `query`
|
|
- `limit` in `query`
|
|
- `expand` in `query`
|
|
|
|
### get_identity_provider_application_user
|
|
|
|
- Operation ID: `get_identity_provider_application_user`
|
|
- Route: `GET /api/v1/idps/{idpId}/users/{userId}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a user for IdP
|
|
- Parameters:
|
|
- `idpId` in `path` required
|
|
- `userId` in `path` required
|
|
|
|
### link_user_to_identity_provider
|
|
|
|
- Operation ID: `link_user_to_identity_provider`
|
|
- Route: `POST /api/v1/idps/{idpId}/users/{userId}`
|
|
- Mode: WRITE
|
|
- Summary: Link a user to IdP
|
|
- Parameters:
|
|
- `idpId` in `path` required
|
|
- `userId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### unlink_user_from_identity_provider
|
|
|
|
- Operation ID: `unlink_user_from_identity_provider`
|
|
- Route: `DELETE /api/v1/idps/{idpId}/users/{userId}`
|
|
- Mode: WRITE
|
|
- Summary: Unlink a user from IdP
|
|
- Parameters:
|
|
- `idpId` in `path` required
|
|
- `userId` in `path` required
|
|
|
|
### list_social_auth_tokens
|
|
|
|
- Operation ID: `list_social_auth_tokens`
|
|
- Route: `GET /api/v1/idps/{idpId}/users/{userId}/credentials/tokens`
|
|
- Mode: READ
|
|
- Summary: List all tokens from OIDC IdP
|
|
- Parameters:
|
|
- `idpId` in `path` required
|
|
- `userId` in `path` required
|