iya-sts
    Preparing search index...

    Variable enrol

    enrol: (
        username: unknown,
        subject: unknown,
        label: unknown,
        by: unknown,
        options?: {
            keyAlg?: string;
            location?: any;
            pinnedKeys?: string[];
            proof?: string;
        },
    ) => any = ...

    Type Declaration

      • (
            username: unknown,
            subject: unknown,
            label: unknown,
            by: unknown,
            options?: {
                keyAlg?: string;
                location?: any;
                pinnedKeys?: string[];
                proof?: string;
            },
        ): any
      • Enrols a subject on a person. The caller decides who may: the portal after a SIOPv2 round trip proved the key, the console and the API for Admin Write.

        Parameters

        • username: unknown

          the person

        • subject: unknown

          the subject

        • label: unknown

          a label for it

        • by: unknown

          who enrolled it

        • Optionaloptions: { keyAlg?: string; location?: any; pinnedKeys?: string[]; proof?: string }

          proof (wallet, realm or issued — the last two for a DID this realm publishes — or admin, the default), for a did:web pinnedKeys: the RFC 7638 thumbprints its sign-ins may use, and for a proof location: where the key came from

        Returns any

        { ok, enrolled, again }, or { ok: false, error }