Variable keysAction

Type Declaration

• • (
        req: any,
        body: any,
        via: any,
    ):
        | {
            accepted?: undefined;
            emergency?: undefined;
            errorCode: any;
            errors: any[];
            href?: undefined;
            message?: undefined;
            ok: boolean;
            runId?: undefined;
            status: any;
            units?: undefined;
        }
        | {
            accepted: boolean;
            emergency: any;
            errorCode?: undefined;
            errors?: undefined;
            href: string;
            message: string;
            ok: boolean;
            runId: any;
            status?: undefined;
            units: any;
        }

  • Queues a rotation, or an emergency rotation, of the realm's signing keys on the scheduler; the one action both the console and POST /admin-api/keys/rotate|emergency call.

    Parameters

    • req: any

      the request, for the actor

    • body: any

      action (rotate or emergency), the units and confirm

    • via: any

      how the action was asked for, for the audit record

    Returns
        | {
            accepted?: undefined;
            emergency?: undefined;
            errorCode: any;
            errors: any[];
            href?: undefined;
            message?: undefined;
            ok: boolean;
            runId?: undefined;
            status: any;
            units?: undefined;
        }
        | {
            accepted: boolean;
            emergency: any;
            errorCode?: undefined;
            errors?: undefined;
            href: string;
            message: string;
            ok: boolean;
            runId: any;
            status?: undefined;
            units: any;
        }

    ok with the run's id and a link to it, or a refusal