--- name: authorization-servers-routes description: Handle 48 OpenAPI operation(s) under /api/v1/authorizationServers for the authorizationServers route group. --- # authorizationServers API Routes Handle 48 OpenAPI operation(s) under /api/v1/authorizationServers for the authorizationServers 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_authorization_servers - Operation ID: `list_authorization_servers` - Route: `GET /api/v1/authorizationServers` - Mode: READ - Summary: List all authorization servers - Parameters: - `q` in `query` - `limit` in `query` - `after` in `query` ### create_authorization_server - Operation ID: `create_authorization_server` - Route: `POST /api/v1/authorizationServers` - Mode: WRITE - Summary: Create an authorization server - Body: JSON request body accepted. ### get_authorization_server - Operation ID: `get_authorization_server` - Route: `GET /api/v1/authorizationServers/{authServerId}` - Mode: READ - Summary: Retrieve an authorization server - Parameters: - `authServerId` in `path` required ### replace_authorization_server - Operation ID: `replace_authorization_server` - Route: `PUT /api/v1/authorizationServers/{authServerId}` - Mode: WRITE - Summary: Replace an authorization server - Parameters: - `authServerId` in `path` required - Body: JSON request body accepted. ### delete_authorization_server - Operation ID: `delete_authorization_server` - Route: `DELETE /api/v1/authorizationServers/{authServerId}` - Mode: WRITE - Summary: Delete an authorization server - Parameters: - `authServerId` in `path` required ### list_associated_servers_by_trusted_type - Operation ID: `list_associated_servers_by_trusted_type` - Route: `GET /api/v1/authorizationServers/{authServerId}/associatedServers` - Mode: READ - Summary: List all associated authorization servers - Parameters: - `authServerId` in `path` required - `trusted` in `query` - `q` in `query` - `limit` in `query` - `after` in `query` ### create_associated_servers - Operation ID: `create_associated_servers` - Route: `POST /api/v1/authorizationServers/{authServerId}/associatedServers` - Mode: WRITE - Summary: Create an associated authorization server - Parameters: - `authServerId` in `path` required - Body: JSON request body accepted. ### delete_associated_server - Operation ID: `delete_associated_server` - Route: `DELETE /api/v1/authorizationServers/{authServerId}/associatedServers/{associatedServerId}` - Mode: WRITE - Summary: Delete an associated authorization server - Parameters: - `authServerId` in `path` required - `associatedServerId` in `path` required ### list_o_auth2_claims - Operation ID: `list_o_auth2_claims` - Route: `GET /api/v1/authorizationServers/{authServerId}/claims` - Mode: READ - Summary: List all custom token claims - Parameters: - `authServerId` in `path` required ### create_o_auth2_claim - Operation ID: `create_o_auth2_claim` - Route: `POST /api/v1/authorizationServers/{authServerId}/claims` - Mode: WRITE - Summary: Create a custom token claim - Parameters: - `authServerId` in `path` required - Body: JSON request body accepted. ### get_o_auth2_claim - Operation ID: `get_o_auth2_claim` - Route: `GET /api/v1/authorizationServers/{authServerId}/claims/{claimId}` - Mode: READ - Summary: Retrieve a custom token claim - Parameters: - `authServerId` in `path` required - `claimId` in `path` required ### replace_o_auth2_claim - Operation ID: `replace_o_auth2_claim` - Route: `PUT /api/v1/authorizationServers/{authServerId}/claims/{claimId}` - Mode: WRITE - Summary: Replace a custom token claim - Parameters: - `authServerId` in `path` required - `claimId` in `path` required - Body: JSON request body accepted. ### delete_o_auth2_claim - Operation ID: `delete_o_auth2_claim` - Route: `DELETE /api/v1/authorizationServers/{authServerId}/claims/{claimId}` - Mode: WRITE - Summary: Delete a custom token claim - Parameters: - `authServerId` in `path` required - `claimId` in `path` required ### list_o_auth2_clients_for_authorization_server - Operation ID: `list_o_auth2_clients_for_authorization_server` - Route: `GET /api/v1/authorizationServers/{authServerId}/clients` - Mode: READ - Summary: List all client resources for an authorization server - Parameters: - `authServerId` in `path` required ### list_refresh_tokens_for_authorization_server_and_client - Operation ID: `list_refresh_tokens_for_authorization_server_and_client` - Route: `GET /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens` - Mode: READ - Summary: List all refresh tokens for a client - Parameters: - `authServerId` in `path` required - `clientId` in `path` required - `expand` in `query` - `after` in `query` - `limit` in `query` ### revoke_refresh_tokens_for_authorization_server_and_client - Operation ID: `revoke_refresh_tokens_for_authorization_server_and_client` - Route: `DELETE /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens` - Mode: WRITE - Summary: Revoke all refresh tokens for a client - Parameters: - `authServerId` in `path` required - `clientId` in `path` required ### get_refresh_token_for_authorization_server_and_client - Operation ID: `get_refresh_token_for_authorization_server_and_client` - Route: `GET /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens/{tokenId}` - Mode: READ - Summary: Retrieve a refresh token for a client - Parameters: - `authServerId` in `path` required - `clientId` in `path` required - `tokenId` in `path` required - `expand` in `query` ### revoke_refresh_token_for_authorization_server_and_client - Operation ID: `revoke_refresh_token_for_authorization_server_and_client` - Route: `DELETE /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens/{tokenId}` - Mode: WRITE - Summary: Revoke a refresh token for a client - Parameters: - `authServerId` in `path` required - `clientId` in `path` required - `tokenId` in `path` required ### list_authorization_server_keys - Operation ID: `list_authorization_server_keys` - Route: `GET /api/v1/authorizationServers/{authServerId}/credentials/keys` - Mode: READ - Summary: List all credential keys - Parameters: - `authServerId` in `path` required ### get_authorization_server_key - Operation ID: `get_authorization_server_key` - Route: `GET /api/v1/authorizationServers/{authServerId}/credentials/keys/{keyId}` - Mode: READ - Summary: Retrieve an authorization server key - Parameters: - `authServerId` in `path` required - `keyId` in `path` required ### rotate_authorization_server_keys - Operation ID: `rotate_authorization_server_keys` - Route: `POST /api/v1/authorizationServers/{authServerId}/credentials/lifecycle/keyRotate` - Mode: WRITE - Summary: Rotate all credential keys - Parameters: - `authServerId` in `path` required - Body: JSON request body accepted. ### activate_authorization_server - Operation ID: `activate_authorization_server` - Route: `POST /api/v1/authorizationServers/{authServerId}/lifecycle/activate` - Mode: WRITE - Summary: Activate an authorization server - Parameters: - `authServerId` in `path` required ### deactivate_authorization_server - Operation ID: `deactivate_authorization_server` - Route: `POST /api/v1/authorizationServers/{authServerId}/lifecycle/deactivate` - Mode: WRITE - Summary: Deactivate an authorization server - Parameters: - `authServerId` in `path` required ### list_authorization_server_policies - Operation ID: `list_authorization_server_policies` - Route: `GET /api/v1/authorizationServers/{authServerId}/policies` - Mode: READ - Summary: List all policies - Parameters: - `authServerId` in `path` required ### create_authorization_server_policy - Operation ID: `create_authorization_server_policy` - Route: `POST /api/v1/authorizationServers/{authServerId}/policies` - Mode: WRITE - Summary: Create a policy - Parameters: - `authServerId` in `path` required - Body: JSON request body accepted. ### get_authorization_server_policy - Operation ID: `get_authorization_server_policy` - Route: `GET /api/v1/authorizationServers/{authServerId}/policies/{policyId}` - Mode: READ - Summary: Retrieve a policy - Parameters: - `authServerId` in `path` required - `policyId` in `path` required ### replace_authorization_server_policy - Operation ID: `replace_authorization_server_policy` - Route: `PUT /api/v1/authorizationServers/{authServerId}/policies/{policyId}` - Mode: WRITE - Summary: Replace a policy - Parameters: - `authServerId` in `path` required - `policyId` in `path` required - Body: JSON request body accepted. ### delete_authorization_server_policy - Operation ID: `delete_authorization_server_policy` - Route: `DELETE /api/v1/authorizationServers/{authServerId}/policies/{policyId}` - Mode: WRITE - Summary: Delete a policy - Parameters: - `authServerId` in `path` required - `policyId` in `path` required ### activate_authorization_server_policy - Operation ID: `activate_authorization_server_policy` - Route: `POST /api/v1/authorizationServers/{authServerId}/policies/{policyId}/lifecycle/activate` - Mode: WRITE - Summary: Activate a policy - Parameters: - `authServerId` in `path` required - `policyId` in `path` required ### deactivate_authorization_server_policy - Operation ID: `deactivate_authorization_server_policy` - Route: `POST /api/v1/authorizationServers/{authServerId}/policies/{policyId}/lifecycle/deactivate` - Mode: WRITE - Summary: Deactivate a policy - Parameters: - `authServerId` in `path` required - `policyId` in `path` required ### list_authorization_server_policy_rules - Operation ID: `list_authorization_server_policy_rules` - Route: `GET /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules` - Mode: READ - Summary: List all policy rules - Parameters: - `authServerId` in `path` required - `policyId` in `path` required ### create_authorization_server_policy_rule - Operation ID: `create_authorization_server_policy_rule` - Route: `POST /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules` - Mode: WRITE - Summary: Create a policy rule - Parameters: - `authServerId` in `path` required - `policyId` in `path` required - Body: JSON request body accepted. ### get_authorization_server_policy_rule - Operation ID: `get_authorization_server_policy_rule` - Route: `GET /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}` - Mode: READ - Summary: Retrieve a policy rule - Parameters: - `authServerId` in `path` required - `policyId` in `path` required - `ruleId` in `path` required ### replace_authorization_server_policy_rule - Operation ID: `replace_authorization_server_policy_rule` - Route: `PUT /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}` - Mode: WRITE - Summary: Replace a policy rule - Parameters: - `authServerId` in `path` required - `policyId` in `path` required - `ruleId` in `path` required - Body: JSON request body accepted. ### delete_authorization_server_policy_rule - Operation ID: `delete_authorization_server_policy_rule` - Route: `DELETE /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}` - Mode: WRITE - Summary: Delete a policy rule - Parameters: - `authServerId` in `path` required - `policyId` in `path` required - `ruleId` in `path` required ### activate_authorization_server_policy_rule - Operation ID: `activate_authorization_server_policy_rule` - Route: `POST /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}/lifecycle/activate` - Mode: WRITE - Summary: Activate a policy rule - Parameters: - `authServerId` in `path` required - `policyId` in `path` required - `ruleId` in `path` required ### deactivate_authorization_server_policy_rule - Operation ID: `deactivate_authorization_server_policy_rule` - Route: `POST /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate` - Mode: WRITE - Summary: Deactivate a policy rule - Parameters: - `authServerId` in `path` required - `policyId` in `path` required - `ruleId` in `path` required ### list_o_auth2_resource_server_json_web_keys - Operation ID: `list_o_auth2_resource_server_json_web_keys` - Route: `GET /api/v1/authorizationServers/{authServerId}/resourceservercredentials/keys` - Mode: READ - Summary: List all Custom Authorization Server Public JSON Web Keys - Parameters: - `authServerId` in `path` required ### add_o_auth2_resource_server_json_web_key - Operation ID: `add_o_auth2_resource_server_json_web_key` - Route: `POST /api/v1/authorizationServers/{authServerId}/resourceservercredentials/keys` - Mode: WRITE - Summary: Add a JSON Web Key - Parameters: - `authServerId` in `path` required - Body: JSON request body accepted. ### get_o_auth2_resource_server_json_web_key - Operation ID: `get_o_auth2_resource_server_json_web_key` - Route: `GET /api/v1/authorizationServers/{authServerId}/resourceservercredentials/keys/{keyId}` - Mode: READ - Summary: Retrieve a Custom Authorization Server Public JSON Web Key - Parameters: - `authServerId` in `path` required - `keyId` in `path` required ### delete_o_auth2_resource_server_json_web_key - Operation ID: `delete_o_auth2_resource_server_json_web_key` - Route: `DELETE /api/v1/authorizationServers/{authServerId}/resourceservercredentials/keys/{keyId}` - Mode: WRITE - Summary: Delete a Custom Authorization Server Public JSON Web Key - Parameters: - `authServerId` in `path` required - `keyId` in `path` required ### activate_o_auth2_resource_server_json_web_key - Operation ID: `activate_o_auth2_resource_server_json_web_key` - Route: `POST /api/v1/authorizationServers/{authServerId}/resourceservercredentials/keys/{keyId}/lifecycle/activate` - Mode: WRITE - Summary: Activate a Custom Authorization Server Public JSON Web Key - Parameters: - `authServerId` in `path` required - `keyId` in `path` required ### deactivate_o_auth2_resource_server_json_web_key - Operation ID: `deactivate_o_auth2_resource_server_json_web_key` - Route: `POST /api/v1/authorizationServers/{authServerId}/resourceservercredentials/keys/{keyId}/lifecycle/deactivate` - Mode: WRITE - Summary: Deactivate a Custom Authorization Server Public JSON Web Key - Parameters: - `authServerId` in `path` required - `keyId` in `path` required ### list_o_auth2_scopes - Operation ID: `list_o_auth2_scopes` - Route: `GET /api/v1/authorizationServers/{authServerId}/scopes` - Mode: READ - Summary: List all custom token scopes - Parameters: - `authServerId` in `path` required - `q` in `query` - `filter` in `query` - `after` in `query` - `limit` in `query` ### create_o_auth2_scope - Operation ID: `create_o_auth2_scope` - Route: `POST /api/v1/authorizationServers/{authServerId}/scopes` - Mode: WRITE - Summary: Create a custom token scope - Parameters: - `authServerId` in `path` required - Body: JSON request body accepted. ### get_o_auth2_scope - Operation ID: `get_o_auth2_scope` - Route: `GET /api/v1/authorizationServers/{authServerId}/scopes/{scopeId}` - Mode: READ - Summary: Retrieve a custom token scope - Parameters: - `authServerId` in `path` required - `scopeId` in `path` required ### replace_o_auth2_scope - Operation ID: `replace_o_auth2_scope` - Route: `PUT /api/v1/authorizationServers/{authServerId}/scopes/{scopeId}` - Mode: WRITE - Summary: Replace a custom token scope - Parameters: - `authServerId` in `path` required - `scopeId` in `path` required - Body: JSON request body accepted. ### delete_o_auth2_scope - Operation ID: `delete_o_auth2_scope` - Route: `DELETE /api/v1/authorizationServers/{authServerId}/scopes/{scopeId}` - Mode: WRITE - Summary: Delete a custom token scope - Parameters: - `authServerId` in `path` required - `scopeId` in `path` required