User Authentication

Our user authentication endpoint provides an IdToken, an AccessToken, and a RefreshToken.

• IdToken : The IdToken is essential for authenticating your subsequent API requests and has an expiry of 60 minutes. Please make sure to save this IdToken and use it as a Bearer token in the Authorization header for other API interactions.

• RefreshToken: To maintain continuous access, the RefreshToken is used to generate a new IdToken whenever the current IdToken expires. The RefreshToken itself has an expiry of 1 year. Make sure to save the RefreshToken securely and use it with our refresh API to obtain new tokens before the current ones expire.

The following rate limit applies to this endpoint: 20 requests per second.

INFO

Your API keys carry many privileges, so be sure to keep them secure. Don't share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

API Endpoint

POST https://api.iimmpact.com/v2/token

Request Body

Parameter	Type	Required	Description
username	string	No	The username of the user requesting the idtoken.
password	string	No	The password of the user requesting the idtoken.

Response 200

To test requests using your account, replace the sample username and password with your created account.

Field	Type	Description
AuthenticationResult	object	The result of the authentication process.
AuthenticationResult.AccessToken	string	The access token generated for the user.
AuthenticationResult.ExpiresIn	number	The time duration until the idtoken expires.
AuthenticationResult.TokenType	string	The type of token being generated.
AuthenticationResult.RefreshToken	string	The refresh token used to obtain a new access token.
AuthenticationResult.IdToken	string	The generated idtoken for the user.

Example Response:

{
  "AuthenticationResult": {
    "AccessToken": "eyJraWQiOiJRN21MeXUydEthSXlPQzNLUTk2RHJjejJWK0ZYdTNEZVwvb0hiOHFGcjlBRT0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI1MzNlMjkwMy02ODAzLTQyNjgtOWNlOS02ZjRlOGYwNWUxMzkiLCJldmVudF9pZCI6ImI3ZDMzNjVkLTgxNTAtNDNhMi1hYTBjLWQ1MWJjODc1NDQxZCIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiYXdzLmNvZ25pdG8uc2lnbmluLnVzZXIuYWRtaW4iLCJhdXRoX3RpbWUiOjE2NDA5MjE2OTAsImlzcyI6Imh0dHBzOlwvXC9jb2duaXRvLWlkcC5hcC1zb3V0aGVhc3QtMS5hbWF6b25hd3MuY29tXC9hcC1zb3V0aGVhc3QtMV81RUVuajVMOXkiLCJleHAiOjE2NDA5MjUyOTAsImlhdCI6MTY0MDkyMTY5MCwianRpIjoiMjM5NTAyYjYtNWZhNC00MzI1LWIzMjMtYTBiNTRhMzRjNWM5IiwiY2xpZW50X2lkIjoiNzZhdjZjZThxamZkMW9lYm10dTRya21zdG0iLCJ1c2VybmFtZSI6InRlc3RlciJ9.jDXA9sAT0u8qDFVvKsXmJgrbZWCQfa9ibzr1WKA-MTeVOjYlDCkRnTlzxiGq8813SdtT5vW9eRaWKi9yL7DrL_JferPpzV20mkOHEU4_4fs-wHtOBK8RTBk43fabk5I0TQgJJWsJFNogiVqvxHNVZfyrDidQEuXFZ43w4NcV3U4FvHbOMXvoxnX1tOb_WCh8vrg7A9nhDOpxAo9GuOKDezNCqS0d_GX4sqyKOpzI8Ll2OMfAflge5ivA3EE5m4tTbnbkcy_ONct_T6HKxLxhe_3rtbIaUE50VR75BG-OPYU5zfSFbU0z4pfnUfzdBU_-byMQf7mRUYdSgaOojzRHPw",
    "ExpiresIn": "3600",
    "TokenType": "Bearer",
    "RefreshToken": "eyJjdHkiOiJKV1QiLCJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiUlNBLU9BRVAifQ.CvG3lxUGJXol_xEOu7hVukJxoKhNxhIgPtOZeLa0h5NlZNRrri-apXYimA0OJVq8t1F_t5pnBueLmmAWGpPvkLul9NLW7MOvboufpUtoDuXZa-OdqydaEd0WsEFOIJa_Y28MT0g4CR5gxjs1fOCoSrRP6NriIIb62v2lxynZT1frNtzdkKpuCnsIgaQIvAd5W8iIi5RMLXgy61-QfxR1SDy1V4wSFC_WkSwDXO8TkwcZBC54vjzTOKU3ExrexyePZuuvhcGwaSFkofj5kSfaGUOHGSYQ-qb-AQVRti2WMge6z4HlTVmUdZR4mUXWnSAdVbKI7gSQfkEfOIYQheduWA.2RSzGUATOYu6LV_u.kjA5SlfAq_CmUed1KL1hhEKMEJ3FdInBVy2IDoyNFANirL_D1bR3D_hLNx68UKF4e0h4yfmtUxY874LtDFlB-5p-8sXJKs-YM-FgpT-Hnigqd8cnpPeZD-oo8N10H5NCjnSWord16-TqKqHm8HTbNgbIrd4ZgD1p5ak7O2mCS6y_3PaXUvma6wBkLVATgHY9JB6E8xp-4pHl0bfCb-nTQhUsjBrPWd7HlaYFmC4L_fHHCUEtE6iHePQ8_o5hA6jg4TiE-u_hQJLVksSTblWix234P2M5bfYhRpapsH0zSbraF42gqmzFu7-eiQDwGYJpvYWKPl6hJHFrRdN-8Q0GXdZ0c77jlr7ty0OZCvdkeXIofvAlRq4ZBcs7_n_6AQzv2Ls7no6KWuRUBzCWFvKZPUboWKhsVShlEM4_O3E6jopKVSairQr6vyMpKmuKQx_Fc_v9xTRIqp53-7FWXgqNtAHiw2HWzchvDTcz0TdqBSdfya48tlPXr4pD5r9bgAKMsziIzPNQJUSjzI4Jr6VOetF5UK75RcGVVN_P3ToLbtEJLHVuqIyZCaStaK0V2YJ3UNO4MUHHXDXYYC5tPOBXKXVke9D_F6f8XK00JG4zeymlwMMcUkW_L08NhPdMhEn1BLeWlyzQA_Jk-ixeCQznfDNSU_RjgOLn_WgqKFGalwo6Hlg0Bg-RefAgGXYHlMcw-BDfcvP43bAcKAFQClWvIaWVFI4GIFImORU_P8u08frByjozMnU0GkOauFtssOE9lOzAnoj3ZwWS409DSqejSn1CdeQQ-MkNW3DHdLraBof8QGlXqBI-u2BT--99G9aw6Cv6z-GnsjF94oTperYUNzu3H31GEr6Ua5O22ZqtOTiiZLXaVxlK50Fnf_tplYMuxWlZay6JzMxdSWEMWUgRi6p2LeOVEmLS3E5Ihva3pC8DMCd9NuNZGUNX5oKuSUAzsEX1MYPcHPl88iaPPTiZtrn_qaQcIfQqMH7DAKsnwoEh2Wbg3Wx6ViKwrM3wGLA3a3o3I9Le-bRgWQbnK72vDeAEN0MdqgNjjS12QVynzgxKSOWqBie3a5MlkzSMrLjnOgPicc2j0eYlfmj40SzPJC2fNvT4D3d_87PsDQ3VsVubVNtDeG1UBpe6z9Di3A2rPAG3iZ3F2x1FYYNqLx8G_E-xkGKyALWIVbKjshHt0GrjSXFlSo7QU2S6JweXi2R21e0mKJV6PzIBRQD4j4wxYJOPk8B_IlpceS2ZFb9Bhg6sSVAxSJoT4who5thLPESmZXKphVH59cioZBk5NZp_0kM.UkX6HojO7pLWpidKC9sZQ",
    "IdToken": "eyJraWQiOiJsbGNGOW5cLzRhYXJqbDR0RUtrVDFcLzN0WWJuakk0V21ESXhBbXYwT2t5TjQ9IiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiI1MzNlMjkwMy02ODAzLTQyNjgtOWNlOS02ZjRlOGYwNWUxMzkiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmFwLXNvdXRoZWFzdC0xLmFtYXpvbmF3cy5jb21cL2FwLXNvdXRoZWFzdC0xXzVFRW5qNUw5eSIsInBob25lX251bWJlcl92ZXJpZmllZCI6dHJ1ZSwiY29nbml0bzp1c2VybmFtZSI6InRlc3RlciIsImF1ZCI6Ijc2YXY2Y2U4cWpmZDFvZWJtdHU0cmttc3RtIiwiZXZlbnRfaWQiOiJiN2QzMzY1ZC04MTUwLTQzYTItYWEwYy1kNTFiYzg3NTQ0MWQiLCJ0b2tlbl91c2UiOiJpZCIsImF1dGhfdGltZSI6MTY0MDkyMTY5MCwibmFtZSI6InRlc3RlciIsInBob25lX251bWJlciI6Iis2MDEwMDAwMDAwMCIsImV4cCI6MTY0MDkyNTI5MCwiaWF0IjoxNjQwOTIxNjkwLCJlbWFpbCI6ImtlbHZpbi5sZWVAaWltbXBhY3QuY29tIn0.X404Q0MphVGa-ifo_g6UN4zejc2GX9s23FvsBF_mhtKbahBrOQuyyS8mivOzdjpckBVuX6Em5vAyA8CgNww7IE9z9GWF65CxrMSMuknBVFMWhHF1HqPAxkaK0g0FMKihKHO4ViyCXGX1yw_gp51gw3iM04K3qZN-RMhTgaacX2HjYfaI3R9cF6NOcFjGwsR-5PZ93FvSVQTwy07-lWImzbNG-9CglsIzTrv4skRzax5m_ojq4dC0MytL5azJ1z6RDTiu6e3nfg_Fsj_NW4JIAFKZvkj_R__N6cozfOZo5bp1Ss-JYObHhGGlDqpdCCgL_vErQUypr2R34pZhBtnRVg"
  }
}

Response 401

{
  "message": "Incorrect username or password."
}