Skip to main content

LoginResponse

Response for login with MFA support.

type LoginResponse {
  success: Boolean!
  requiresMfa: Boolean!
  requiresSetup: Boolean!
  message: String
  mfaChallenge: MfaChallenge
  accessToken: String
  refreshToken: String
  expiresIn: Int
  tokenType: String
  user: User
}

Fields​

LoginResponse.success ● Boolean! non-null scalar​

Success status.

LoginResponse.requiresMfa ● Boolean! non-null scalar​

Whether MFA is required.

LoginResponse.requiresSetup ● Boolean! non-null scalar​

Whether MFA setup is required.

LoginResponse.message ● String scalar​

Message for the user.

LoginResponse.mfaChallenge ● MfaChallenge object​

MFA challenge details (only when requiresMfa is true).

LoginResponse.accessToken ● String scalar​

The access token (only when login is successful).

LoginResponse.refreshToken ● String scalar​

The refresh token (only when login is successful).

LoginResponse.expiresIn ● Int scalar​

Represents in how many seconds the access token expires (only when login is successful).

LoginResponse.tokenType ● String scalar​

Represents the tokens type (only when login is successful).

LoginResponse.user ● User object​

Represents information about the user (only when login is successful).

Returned By​

login mutation