1. Docs
  2. API Reference
  3. Resolve whether an email routes to end-user SSO for a client

Resolve whether an email routes to end-user SSO for a client

POST/oauth/sso/routing/resolve

Public hosted-login routing: given an email and client_id, resolves whether the email's domain routes to an end-user SSO connection linked to that OAuth client. POST returning sso_available with the matched connection_id and type (saml/oidc) so the hosted login page can hand off to the SP login endpoint, or sso_available: false so it reveals the password field. Lookups are scoped to the OAuth client, since end-user connection placement is per-client. Rate-limited to 20 per minute as an anti-enumeration cap.

Request body

application/json

emailstring Required

End-user's email; routed by its domain.

client_idstring Required

OAuth client the user is signing into.

Responses

application/json

  • dataResolveEnduserRoutingResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Rate limit

20 requests per 1mPer caller: the signed-in user for a bearer token; for an API key, the key and the end user's address when a backend forwards it, otherwise the client address

Returned object

ResolveEnduserRoutingResponseDtoView all properties on this resource
Request
curl -X POST "https://auth.canopy-io.com/oauth/sso/routing/resolve" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "string",
    "client_id": "string"
  }'
Response
{
  "data": {
    "sso_available": false,
    "connection_id": "string",
    "type": "saml",
    "allowed_methods": [
      "string"
    ]
  }
}
 Related endpoints Was this page helpful?

Tell us how we can improve this guide.

Canopy