Skip to content

Ways to sign in to the account​

GET
/cognito/sign-in-methods

Which of Google, Apple and a password the signed-in account has, which one this session signed in with, and when each was added or last changed where that is known. Read from the user pool on every call; 503 SIGN_IN_METHODS_UNAVAILABLE when it cannot be read.

currentMethod is null when it cannot be told for certain (for example a Bearer session that sends no access token); it is never a guess. recentSignIn.fresh says whether this session may create a password now. lastConnect is the result of the last connect round trip, for ten minutes; providerEmail is set only for email_mismatch.

An API key and an admin acting as the user get the list, with currentMethod null, recentSignIn.fresh false and lastConnect null.

canDisconnect / disconnectBlockedReason on each provider say whether DELETE /cognito/sign-in-methods/{provider} would remove it.

Rate limited at 30 requests/minute per account and 60 per IP.

Authorizations​

BearerAuth

In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.

Type
HTTP (bearer)

Responses​

The account's ways to sign in

application/json
JSON
"string"

Playground​

Server
Authorization

Samples​

Powered by VitePress OpenAPI

Built with VitePress