Auth
Ask whether an address signs in with single sign-on
{ sso: true } only when the address's domain is verified by an organisation whose single sign-on is on and whose plan has it; otherwise { sso: false } and the emailed code works as before.
POST
/auth/sso/discoverTL;DR
| Question | Answer |
|---|---|
| What does it do? | Ask whether an address signs in with single sign-on. |
| What does it take? | A JSON body of type SsoDiscoverBody. |
| What does it return? | Status 200 with a body of type SsoDiscover. |
| What can go wrong? | 400 the address is not valid; 403 the request came from an origin that may not sign in; 429 too many requests. Every failure uses the one error envelope. |
What it does
{ sso: true } only when the address's domain is verified by an organisation whose single sign-on is on and whose plan has it; otherwise { sso: false } and the emailed code works as before. Names no organisation.
Request body
The body has the type SsoDiscoverBody.
| Field | Type | Required | Description |
|---|---|---|---|
email | string | yes | at least 3 characters; at most 254 characters. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | Whether to offer single sign-on. | SsoDiscover |
| 400 | The address is not valid. | ErrorResponse |
| 403 | The request came from an origin that may not sign in. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
Response body
A 200 answer has the type SsoDiscover.
| Field | Type | Required | Description |
|---|---|---|---|
sso | boolean | yes | True when the address's domain signs in through an organisation's identity provider. Names no organisation. |
See also
| Doc | Why |
|---|---|
| API reference | Every endpoint, and the error envelope |
| Schemas | Every request and response type |
| Tool reference | The operations as callable tools |