Hanzo
OpenapiO11y

Tells a sign-in page what an email address can do: which orgs the address…

Tells a sign-in page what an email address can do: which orgs the address belongs to and, per org, which password and SSO routes are open to it.

GET /v1/o11y/sessions/context

Addresshttps://api.hanzo.ai/v1/o11y/sessions/context
MethodGET
OperationGetSessionContext
AuthAuthorization: Bearer $HANZO_API_KEY

Tells a sign-in page what an email address can do: which orgs the address belongs to and, per org, which password and SSO routes are open to it. Unauthenticated: it runs before any session exists.

Request

2 fields.

FieldInTypeRequiredDescription
emailquerystringEmail is the address about to sign in.
refquerystringRef is the page the sign-in started from, carried into SSO redirects.

Response

StatusBodyMeaning
200o11y.O11ySessionContextOutok

200 body — 23 fields.

FieldInTypeAlwaysDescription
databodyo11y.O11ySessionContext
data.existsbodybooleanExists says whether any account carries the address.
data.orgsbodyo11y.O11ySessionOrg[]Orgs are the orgs the address belongs to, each with its sign-in routes.
data.orgs[].authNSupportbodyo11y.O11yAuthNSupport
data.orgs[].authNSupport.callbackbodyo11y.O11yCallbackAuthN[]Callback are the SSO routes; each is begun by visiting its URL.
data.orgs[].authNSupport.callback[].providerbodystringProvider is the route's provider — google_auth, saml or oidc.
data.orgs[].authNSupport.callback[].urlbodystringURL is where the browser goes to begin the flow.
data.orgs[].authNSupport.passwordbodyo11y.O11yPasswordAuthN[]Password are the password routes.
data.orgs[].authNSupport.password[].providerbodystringProvider is the route's provider, e.g.
data.orgs[].idbodystringID is the org id.
data.orgs[].namebodystringName is the org's display name.
data.orgs[].warningbodyo11y.O11yErrorDetail
data.orgs[].warning.codebodystringCode is the machine-readable code.
data.orgs[].warning.errorsbodyo11y.O11yErrorItem[]Errors are further details, one message and its suggestions each.
data.orgs[].warning.errors[].messagebodystringMessage is the detail.
data.orgs[].warning.errors[].suggestionsbodystring[]Suggestions say what to try about this detail.
data.orgs[].warning.messagebodystringMessage is the human-readable reason.
data.orgs[].warning.retrybodyo11y.O11yRetry
data.orgs[].warning.retry.delaybodyintegerDelay is how long to wait before retrying, in nanoseconds.
data.orgs[].warning.suggestionsbodystring[]Suggestions say what to try instead.
data.orgs[].warning.typebodystringType is the error's category, e.g.
data.orgs[].warning.urlbodystringUrl points at documentation for the error, when there is any.
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y sessions context

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page