iya-sts
    Preparing search index...
    revoke: (
        username: any,
        purpose: any,
        handle: any,
        reasonId: any,
        opts: any,
    ) => any = revoke

    Type Declaration

      • (username: any, purpose: any, handle: any, reasonId: any, opts: any): any
      • Revokes one of a person's key pairs for one profile, found by handle or serial among that person's key pairs only.

        Puts the certificate on its authority's CRL (an external authority's is marked revoked here only), drops the private half, and clears the profile's issuer declaration when no valid key pair is left. Raises CAEP (and, for keyCompromise, RISC) events.

        Parameters

        • username: any

          the person's username

        • purpose: any

          jwt (the default) or saml

        • handle: any

          the key pair's kid or thumbprint, or its serial in hex

        • reasonId: any

          one of REVOCATION_REASONS; cessationOfOperation otherwise

        • opts: any

          initiatingEntity (user or admin) and via, for the events and the revocation entry's note

        Returns any

        { ok: true, key, reason, already, onList, why }, or { ok: false, errorCode, errors } when the person holds no such key pair