Variable mapIncoming

Type Declaration

• • (
        record: RelationshipLike,
        bag: Record<string, any>,
        subject?: unknown,
    ): {
        attributes: Record<string, string[]>;
        flat: Record<string, string[]>;
        mapped: any[];
        unmapped: any[];
        username: string;
        usernameFrom: string;
        usernamePrefixed: boolean;
        usernameRaw: string;
    }

  • Maps one federated sign-in's attributes: the attributes for the directory, what was mapped and where, what was not, and the username.

    Values of two names mapped to one attribute are joined, each value kept once.

    Parameters

    • record: RelationshipLike

      the federation relationship

    • bag: Record<string, any>

      the incoming attributes or claims

    • Optionalsubject: unknown

      the subject the protocol carried

    Returns {
        attributes: Record<string, string[]>;
        flat: Record<string, string[]>;
        mapped: any[];
        unmapped: any[];
        username: string;
        usernameFrom: string;
        usernamePrefixed: boolean;
        usernameRaw: string;
    }

    { username, usernameRaw, usernameFrom, usernamePrefixed, attributes, mapped, unmapped, flat }