Package org.keycloak.protocol.oid4vc.issuance.credentialoffer.preauth

Interface PreAuthCodeHandler

All Superinterfaces:
org.keycloak.provider.Provider
All Known Implementing Classes:
JwtPreAuthCodeHandler
public interface PreAuthCodeHandler extends org.keycloak.provider.Provider
Handles the production and verification of pre-authorized codes.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    createPreAuthCode(PreAuthCodeCtx ctx)
    Generates a pre-authorized code for a given context of non-sensitive fields.
    PreAuthCodeCtx
    verifyPreAuthCode(String preAuthCode)
    Verifies the given pre-authorized code and returns its associated context if valid.

    Methods inherited from interface org.keycloak.provider.Provider

    close

  • Method Details

    • createPreAuthCode

      String createPreAuthCode(PreAuthCodeCtx ctx)
      Generates a pre-authorized code for a given context of non-sensitive fields. The implementation is responsible for embedding this context so it is recovered with verification.

    • verifyPreAuthCode

      PreAuthCodeCtx verifyPreAuthCode(String preAuthCode) throws org.keycloak.common.VerificationException
      Verifies the given pre-authorized code and returns its associated context if valid.
      Throws:
      org.keycloak.common.VerificationException