Skip to main content

Passthrough Delete

Loading...
API endpoint path: /mx/{institutionId}/{mxSsoResourcePath}

Transparent passthrough for DELETE requests to the MX SSO APIs. The service provides a RESTful interface for authenticating users on the MX platform; endpoint paths, headers, and query parameters are defined in the MX documentation.

Use this endpoint to:

  • Invoke MX SSO DELETE APIs to end authenticated user sessions on the MX platform — the primary use case is delete user session, which closes all open sessions for the specified user.
  • Call this operation when a user signs out of your application or when you need to revoke active MX SSO sessions (for example, after credential changes or account closure).
  • Access MX SSO delete operations through the Candescent API Gateway instead of calling MX directly.

Behavior and capabilities:

  • The gateway validates the OAuth V2 bearer token, correlationId, and ext_host, injects MD-API-KEY for MXSSO routing, and removes Candescent-specific headers before forwarding the request to MX.
  • Proxies requests using the path /mx/{institutionId}/{mxSsoResourcePath}, where institutionId corresponds to the MX client_id (used in MX paths such as /{client_id}/...), must match the value in the OAuth V2 token, and is used when forwarding requests to MX.
  • Forwards all MX-supported headers, paths, and query parameters without modification.
  • Returns MX HTTP status codes without modification.

Request​

Responses​

No Content