Variable subjectForUser

Type Declaration

• • (
        userid: any,
        format: any,
        issuer: any,
        facts: any,
    ):
        | { format: string; iss: string; sub: string }
        | {
            email: any;
            format: string;
            id?: undefined;
            identifiers?: undefined;
            phone_number?: undefined;
            uri?: undefined;
            url?: undefined;
        }
        | {
            email?: undefined;
            format: string;
            id?: undefined;
            identifiers?: undefined;
            phone_number?: undefined;
            uri: string;
            url?: undefined;
        }
        | {
            email?: undefined;
            format: string;
            id: string;
            identifiers?: undefined;
            phone_number?: undefined;
            uri?: undefined;
            url?: undefined;
        }
        | {
            email?: undefined;
            format: string;
            id?: undefined;
            identifiers?: undefined;
            phone_number?: undefined;
            uri?: undefined;
            url: string;
        }
        | {
            email?: undefined;
            format: string;
            id?: undefined;
            identifiers?: undefined;
            phone_number: string;
            uri?: undefined;
            url?: undefined;
        }
        | {
            email?: undefined;
            format: string;
            id?: undefined;
            identifiers: any[];
            phone_number?: undefined;
            uri?: undefined;
            url?: undefined;
        }

  • Returns the Subject Identifier for a person, in the format a stream asked for.

    Real facts win. Where a format needs a value the caller does not hold, development mode invents one and product mode falls back to iss_sub, whose sub is the person's urn:uuid:<entryUUID>. A format that is not a person's gets iss_sub too.

    Parameters

    • userid: any

      the person's username

    • format: any

      the stream's subject format

    • issuer: any

      this service's issuer

    • facts: any

      { mail, phone, did, subject }, each optional

    Returns
        | { format: string; iss: string; sub: string }
        | {
            email: any;
            format: string;
            id?: undefined;
            identifiers?: undefined;
            phone_number?: undefined;
            uri?: undefined;
            url?: undefined;
        }
        | {
            email?: undefined;
            format: string;
            id?: undefined;
            identifiers?: undefined;
            phone_number?: undefined;
            uri: string;
            url?: undefined;
        }
        | {
            email?: undefined;
            format: string;
            id: string;
            identifiers?: undefined;
            phone_number?: undefined;
            uri?: undefined;
            url?: undefined;
        }
        | {
            email?: undefined;
            format: string;
            id?: undefined;
            identifiers?: undefined;
            phone_number?: undefined;
            uri?: undefined;
            url: string;
        }
        | {
            email?: undefined;
            format: string;
            id?: undefined;
            identifiers?: undefined;
            phone_number: string;
            uri?: undefined;
            url?: undefined;
        }
        | {
            email?: undefined;
            format: string;
            id?: undefined;
            identifiers: any[];
            phone_number?: undefined;
            uri?: undefined;
            url?: undefined;
        }

    the Subject Identifier