Login API Documentation

​

Overview

​

Endpoint

​

Domain

​

Request

​

Request Body Parameters

• UserName (string): The username or ClientID of the user attempting to log in.
• TenantName (string): The name of the tenant that the user belongs to.
• Password (string): The password or Secret of the user.

​

Example Request

{
  "UserName": "string",
  "TenantName": "string",
  "Password": "string"
}

​

Response

​

Response Body Parameters

• cognitoToken (object): An object containing the tokens and related information.
  • ChallengeParameters (object): An object containing challenge parameters (if any). This is typically empty ({}) but included for completeness.
  • AuthenticationResult (object): An object containing the authentication result.
    • IdToken (string): The JWT token that serves as the identity token.
    • TokenType (string): The type of token provided.
    • ExpiresIn (integer): The expiration time of the token in seconds.
    • RefreshToken (string): The token used to refresh the authentication when the current token expires.
    • AccessToken (string): The token used to access API resources.

​

Example Response

{
  "cognitoToken": {
    "ChallengeParameters": {},
    "AuthenticationResult": {
      "IdToken": "string",
      "TokenType": "string",
      "ExpiresIn": 0,
      "RefreshToken": "string",
      "AccessToken": "string"
    }
  }
}

​

Security Considerations

• The Login API should be accessed over HTTPS to ensure the confidentiality and integrity of the transmitted credentials.
• Passwords should be stored securely and never logged or written to any insecure location.
• Tokens should be securely stored on the client side and transmitted using the Authorization header in API requests requiring authentication.

​

Error Handling