AuthResponse

The result of a sign in.

type AuthResponse {
  accessToken: String
  expiresIn: Int
  mustChangePassword: Boolean
  organization: Organization
  organizationId: String
  partnerId: String
  refreshToken: String
  requires2FA: Boolean
  requires2FASetup: Boolean
  sessionToken: String
  tempToken: String
  tokenType: String
  user: User
  userId: String
  userType: String
}

Fields

AuthResponse.accessToken ● String scalar

The token to send with requests.

AuthResponse.expiresIn ● Int scalar

How many seconds the access token lasts.

AuthResponse.mustChangePassword ● Boolean scalar

True when the user must change their password first.

AuthResponse.organization ● Organization object

The organization the user signed in to.

AuthResponse.organizationId ● String scalar

The ID of the organization the record belongs to.

AuthResponse.partnerId ● String scalar

The ID of the partner.

AuthResponse.refreshToken ● String scalar

The token to get a new access token.

AuthResponse.requires2FA ● Boolean scalar

True when a two-factor code is needed to finish signing in.

AuthResponse.requires2FASetup ● Boolean scalar

True when the user must set up two-factor sign in first.

AuthResponse.sessionToken ● String scalar

The token that identifies the session.

AuthResponse.tempToken ● String scalar

A single-use token for the two-factor step.

AuthResponse.tokenType ● String scalar

The kind of token, for example Bearer.

AuthResponse.user ● User object

The signed-in user.

AuthResponse.userId ● String scalar

The ID of the user.

AuthResponse.userType ● String scalar

The kind of user, such as staff or customer.

Returned By

login mutation ● loginWithOtp mutation ● refreshToken mutation ● switchOrganization mutation ● verifyTwoFactor mutation