nuxt-community / auth-module

Zero-boilerplate authentication support for Nuxt 2
https://auth.nuxtjs.org
MIT License
1.93k stars 924 forks source link

Missing documentation for `idToken` #1770

Open bhrutledge opened 2 years ago

bhrutledge commented 2 years ago

When using the OpenIDConnect scheme, it looks like $auth.strategy.idToken is set, in addition to token and refreshToken. However, I don't see that documented anywhere. Should it be added to https://auth.nuxtjs.org/api/tokens?

Version

module: 5.0.0-1648802546.c9880dc nuxt: 2.15.8

Nuxt configuration

mode:

Nuxt configuration

  auth: {
    strategies: {
      cognitoOIDC: {
        scheme: 'openIDConnect',
        // https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-userpools-server-contract-reference.html
        endpoints: {
          configuration:
            'https://cognito-idp.us-east-1.amazonaws.com/USER_POOL_ID/.well-known/openid-configuration',
        },
        clientId: 'CLIENT_ID',
        // HACK: Specify scope as a string instead of an array to override invalid default
        // https://github.com/nuxt-community/auth-module/issues/1359
        scope: 'openid',
      },
    },
  },

Checklist