Package akka.javasdk.annotations

Annotation Interface JWT

@Target({METHOD,TYPE}) @Retention(RUNTIME) @Documented public @interface JWT

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    JWT.JwtMethodMode
     
    static @interface 
    JWT.StaticClaim
    A static claim is a claim that is required to be present on the token, and have a particular value.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    bearerTokenIssuers
    If set, then the token extracted from the bearer token must have one of these issuers.
    JWT.StaticClaim[]
    staticClaims
    If set, the static claims provided and their values will be required when calling the service.
    JWT.JwtMethodMode[]
    validate
     

  • Element Details

    • validate

      JWT.JwtMethodMode[] validate
      Default:
      {UNSPECIFIED}

    • bearerTokenIssuers

      String[] bearerTokenIssuers
      If set, then the token extracted from the bearer token must have one of these issuers.

      This can be used in combination with the issuer field of configuration for JWT secrets. If there is at least one secret that has this issuer set, then only the secrets with that issuer set will be used for validation. This ensures that the token comes from a particular issuer.

      Default:
      {}

    • staticClaims

      JWT.StaticClaim[] staticClaims
      If set, the static claims provided and their values will be required when calling the service. When multiple claims are provided, all of them will be required to successfully call the service.
      Default:
      {}