Skip to content
Migrating from NextAuth.js v4? Read our migration guide.
API reference
vipps

providers/vipps

VippsProfile

See

User Profile Structure

Extends

Properties

accounts

accounts: {
  account_name: string;
  account_number: number;
  bank_name: string;
  }[];

address

address: Address;

birthdate

birthdate: string;

delegatedConsents

delegatedConsents: {
  confirmConsentButtonText: string;
  consents: {
     accepted: boolean;
     id: string;
     required: boolean;
     textDisplayedToUser: string;
  }[];
  heading: string;
  language: string;
  links: {
     privacyStatementLinkText: string;
     privacyStatementLinkUrl: string;
     termsLinkText: string;
     termsLinkUrl: string;
  };
  termsDescription: string;
  timeOfConsent: string;
};
confirmConsentButtonText
confirmConsentButtonText: string;
consents
consents: {
  accepted: boolean;
  id: string;
  required: boolean;
  textDisplayedToUser: string;
  }[];
heading
heading: string;
language
language: string;
links: {
  privacyStatementLinkText: string;
  privacyStatementLinkUrl: string;
  termsLinkText: string;
  termsLinkUrl: string;
};
links.privacyStatementLinkText
privacyStatementLinkText: string;
links.privacyStatementLinkUrl
privacyStatementLinkUrl: string;
links.termsLinkText
termsLinkText: string;
links.termsLinkUrl
termsLinkUrl: string;
termsDescription
termsDescription: string;
timeOfConsent
timeOfConsent: string;

email

email: string;

email_verified

email_verified: boolean;

family_name

family_name: string;

given_name

given_name: string;

name

name: string;

nin

nin: string;

other_addresses

other_addresses: Address[];

phone_number

phone_number: string;

sid

sid: string;

sub

sub: string;

default()

default(options): OIDCConfig<VippsProfile>

Parameters

ParameterType
optionsOIDCUserConfig<VippsProfile>

Returns

OIDCConfig<VippsProfile>

See

Vipps Login API

Example

import Vipps from "@auth/core/providers/vipps"
...
providers: [
 Vipps({
   clientId: process.env.AUTH_VIPPS_ID,
   clientSecret: process.env.AUTH_VIPPS_SECRET,
 })
]
...

note If you’re testing, make sure to override the issuer option with apitest.vipps.no

Auth.js © Balázs Orbán and Team - 2024