iya-sts
    Preparing search index...

    Variable issueJoinToken

    issueJoinToken: (
        request: any,
    ) =>
        | {
            agentSpiffeId?: undefined;
            errorCode: string;
            expiresAt?: undefined;
            message: string;
            ok: boolean;
            status: any;
            token?: undefined;
        }
        | {
            agentSpiffeId: any;
            errorCode?: undefined;
            expiresAt: any;
            message?: undefined;
            ok: boolean;
            status?: undefined;
            token: any;
        } = ...

    Type Declaration

      • (
            request: any,
        ):
            | {
                agentSpiffeId?: undefined;
                errorCode: string;
                expiresAt?: undefined;
                message: string;
                ok: boolean;
                status: any;
                token?: undefined;
            }
            | {
                agentSpiffeId: any;
                errorCode?: undefined;
                expiresAt: any;
                message?: undefined;
                ok: boolean;
                status?: undefined;
                token: any;
            }
      • Mints one join token into this realm's store.

        A non-positive ttl uses spiffe.joinTokenTtl. An agentId is the alias SPIRE registers, parented on the agent the token will attest, and is checked before the token exists. The token itself is returned once and stored only as a digest.

        Parameters

        • request: any

          ttl, an optional token (a test's; otherwise a new UUID), an optional alias agentId, and the audit's actor, protocol and channel

        Returns
            | {
                agentSpiffeId?: undefined;
                errorCode: string;
                expiresAt?: undefined;
                message: string;
                ok: boolean;
                status: any;
                token?: undefined;
            }
            | {
                agentSpiffeId: any;
                errorCode?: undefined;
                expiresAt: any;
                message?: undefined;
                ok: boolean;
                status?: undefined;
                token: any;
            }

        { ok: true, token, expiresAt, agentSpiffeId }, or { ok: false, errorCode, status, message }