@xeedware/cognito-jwt
Version:
AWS Cognito AccessToken and IdToken classes.
147 lines • 3.65 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.IdToken = void 0;
// Open ID Connect specification: http://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
const JsonWebToken_1 = require("./JsonWebToken");
/** @class */
class IdToken extends JsonWebToken_1.JsonWebToken {
/**
* Constructs a new CognitoJwtToken object
* @param {string} token The JWT token.
* @param {string} [pem]
* @param {VerifyOptions} [options]
*/
constructor(token, pem, options) {
super(token, pem, options);
this.pem = pem;
}
/**
* Get the JWT payload
* @returns {IdTokenPayload}
*/
getIdTokenPayload() {
return super.getJwtPayload();
}
/**
* Get the user's address
* @returns {Object}
*/
get address() {
return this.getIdTokenPayload().address;
}
/**
* Get the user's birthdate represented as an ISO 8601:2004 [ISO8601‑2004] YYYY-MM-DD format.
* @returns {string}
*/
get birthdate() {
return this.getIdTokenPayload().birthdate;
}
/**
* Get the user's email address
* @returns {string}
*/
get email() {
return this.getIdTokenPayload().email;
}
/**
* Closed question if email address has been verified.
* @returns {boolean}
*/
get email_verified() {
return this.getIdTokenPayload().email_verified;
}
/**
* Get the user's family name.
* @returns {string}
*/
get family_name() {
return this.getIdTokenPayload().family_name;
}
/**
* Get the user's gender
* @returns {string}
*/
get gender() {
return this.getIdTokenPayload().gender;
}
/**
* Get the user's given name.
* @returns {string}
*/
get given_name() {
return this.getIdTokenPayload().given_name;
}
/**
* Get the user's locale.
* @returns {string}
*/
get locale() {
return this.getIdTokenPayload().locale;
}
/**
* Get the user's middle name.
* @returns {string}
*/
get middle_name() {
return this.getIdTokenPayload().middle_name;
}
/**
* Get the user's full name.
* @returns {string}
*/
get name() {
return this.getIdTokenPayload().name;
}
/**
* Get the user's nickname.
* @returns {string}
*/
get nickname() {
return this.getIdTokenPayload().nickname;
}
/**
* Get the user's phone number.
* @returns {string}
*/
get phone_number() {
return this.getIdTokenPayload().phone_number;
}
/**
* Closed question asking if phone number has been verified.
* @returns {boolean}
*/
get phone_number_verified() {
return this.getIdTokenPayload().phone_number_verified;
}
/**
* Get a URL to the user's picture.
* @returns {string}
*/
get picture() {
return this.getIdTokenPayload().picture;
}
/**
* Get the user's preferred name.
* @returns {string}
*/
get preferred_username() {
return this.getIdTokenPayload().preferred_username;
}
get profile() {
return this.getIdTokenPayload().profile;
}
get sub() {
return this.getIdTokenPayload().sub;
}
get updated_at() {
return this.getIdTokenPayload().updated_at;
}
get website() {
return this.getIdTokenPayload().website;
}
get zoneinfo() {
return this.getIdTokenPayload().zoneinfo;
}
}
exports.IdToken = IdToken;
//# sourceMappingURL=IdToken.js.map