Authentication

Sign in and get tokens

Authenticates against Cognito using the USER_PASSWORD_AUTH flow and returns an id token plus a refresh token.

Send id_token as the Authorization header on every authenticated request — raw, with no Bearer prefix. It expires after expires_in seconds (3600 by default); use POST /refresh_token to get a new one without re-prompting for the password.

post/signin

Request

  • Base URL: https://api.indexone.io
  • URL: https://api.indexone.io/signin
  • Auth: API key in header x-api-key

Request body

usernamestring email required

Lower-cased server-side, so case does not matter.

passwordstring required

Response

Authenticated.

id_tokenstring

Cognito id token (JWT). Send as Authorization, no prefix.

refresh_tokenstring

Long-lived; exchange at POST /refresh_token.

expires_ininteger

Lifetime of id_token in seconds.

Changes

No recorded changes to this operation across all 1 revision of this API.