@asgardeo/auth-js/src/models/user.ts

Asgardeo Auth JS SDK to be used in JavaScript and TypeScript applications.

/**
 * Copyright (c) 2020, WSO2 LLC. (https://www.wso2.com). All Rights Reserved.
 *
 * WSO2 LLC. licenses this file to you under the Apache License,
 * Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

/**
 * Interface containing the basic user information.
 */
export interface BasicUserInfo {
    /**
     * The email address of the user.
     */
    email?: string | undefined;
    /**
     * 	The username of the user.
     */
    username?: string | undefined;
    /**
     * The display name of the user. It is the preferred_username in the id token payload or the `sub`.
     */
    displayName?: string | undefined;
    /**
     * The scopes allowed for the user.
     */
    allowedScopes: string;
    /**
     * The tenant domain to which the user belongs.
     */
    tenantDomain?: string | undefined;
    /**
     * The session state.
     */
    sessionState: string;
    /**
     * The `uid` corresponding to the user who the ID token belongs to.
     */
    sub?: string;
    /**
     * Any other attributes retrieved from teh `id_token`.
     */
    [ key: string ]: any;
}

/**
 * Interface of the authenticated user.
 */
export interface AuthenticatedUserInfo {
    /**
     * Authenticated user's display name.
     */
    displayName?: string | undefined;
    /**
     * Authenticated user's display name.
     * @deprecated Use `displayName` instead.
     */
    display_name?: string | undefined;
    /**
     * User's email.
     */
    email?: string | undefined;
    /**
     * Available scopes.
     */
    scope?: string | undefined;
    /**
     * Authenticated user's tenant domain.
     */
    tenantDomain?: string | undefined;
    /**
     * Authenticated user's username.
     */
    username: string;
    [key: string]: any;
}