7.4 KiB
7.4 KiB
name, description
| name | description |
|---|---|
| idps-routes | 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:
qinqueryafterinquerylimitinquerytypeinquery
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:
afterinquerylimitinquery
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:
kidinpathrequired
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:
kidinpathrequired
- 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:
kidinpathrequired
get_identity_provider
- Operation ID:
get_identity_provider - Route:
GET /api/v1/idps/{idpId} - Mode: READ
- Summary: Retrieve an IdP
- Parameters:
idpIdinpathrequired
replace_identity_provider
- Operation ID:
replace_identity_provider - Route:
PUT /api/v1/idps/{idpId} - Mode: WRITE
- Summary: Replace an IdP
- Parameters:
idpIdinpathrequired
- 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:
idpIdinpathrequired
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:
idpIdinpathrequired
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:
idpIdinpathrequired
- 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:
idpIdinpathrequiredidpCsrIdinpathrequired
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:
idpIdinpathrequiredidpCsrIdinpathrequired
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:
idpIdinpathrequiredidpCsrIdinpathrequired
- 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:
idpIdinpathrequired
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:
idpIdinpathrequired
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:
idpIdinpathrequiredvalidityYearsinqueryrequired
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:
idpIdinpathrequiredkidinpathrequired
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:
idpIdinpathrequiredkidinpathrequiredtargetIdpIdinqueryrequired
activate_identity_provider
- Operation ID:
activate_identity_provider - Route:
POST /api/v1/idps/{idpId}/lifecycle/activate - Mode: WRITE
- Summary: Activate an IdP
- Parameters:
idpIdinpathrequired
deactivate_identity_provider
- Operation ID:
deactivate_identity_provider - Route:
POST /api/v1/idps/{idpId}/lifecycle/deactivate - Mode: WRITE
- Summary: Deactivate an IdP
- Parameters:
idpIdinpathrequired
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:
idpIdinpathrequiredqinqueryafterinquerylimitinqueryexpandinquery
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:
idpIdinpathrequireduserIdinpathrequired
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:
idpIdinpathrequireduserIdinpathrequired
- 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:
idpIdinpathrequireduserIdinpathrequired
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:
idpIdinpathrequireduserIdinpathrequired