Package co.ankatech.keymanagement.client.auth.model

Class AuthorizationServerMetadata

java.lang.Object
co.ankatech.keymanagement.client.auth.model.AuthorizationServerMetadata
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class AuthorizationServerMetadata extends Object
OAuth 2.0 authorization server metadata (RFC 8414 §2). The members a client of this service needs: the issuer its tokens carry, where to request a token, where to fetch the keys that verify it, and the algorithms a DPoP proof may use.

  • Field Details

  • Constructor Details

    • AuthorizationServerMetadata

      public AuthorizationServerMetadata()

  • Method Details

    • getDpopSigningAlgValuesSupportedAsString

      public List<String> getDpopSigningAlgValuesSupportedAsString()
      The wire values of dpop_signing_alg_values_supported, in order: what the server sent, verbatim.
      • For a value this release declares, the same wire value the enum names.
      • For a value it does not declare (one a later server added), the server's wire value verbatim, while the matching element of getDpopSigningAlgValuesSupported() reads UNKNOWN_DEFAULT_OPEN_API; writing this model sends that wire value back, never the sentinel.
      • For an absent member, null.
      Returns:
      the wire values, or null when the member is absent

    • issuer

      public AuthorizationServerMetadata issuer(@Nonnull String issuer)

    • getIssuer

      @Nonnull public String getIssuer()
      The issuer identifier: the `iss` claim of every access token this service issues. It names the platform's authorization server and is the same in every deployment; compare a token's `iss` with it, not with the URL this document was read from.
      Returns:
      issuer

    • setIssuer

      public void setIssuer(@Nonnull String issuer)

    • tokenEndpoint

      public AuthorizationServerMetadata tokenEndpoint(@Nonnull String tokenEndpoint)

    • getTokenEndpoint

      @Nonnull public String getTokenEndpoint()
      The public URL of the token endpoint. A DPoP proof sent to it names this URL as its `htu`.
      Returns:
      tokenEndpoint

    • setTokenEndpoint

      public void setTokenEndpoint(@Nonnull String tokenEndpoint)

    • jwksUri

      public AuthorizationServerMetadata jwksUri(@Nonnull String jwksUri)

    • getJwksUri

      @Nonnull public String getJwksUri()
      The public URL of the JWK Set holding the keys that verify this service's access tokens.
      Returns:
      jwksUri

    • setJwksUri

      public void setJwksUri(@Nonnull String jwksUri)

    • introspectionEndpoint

      public AuthorizationServerMetadata introspectionEndpoint(@Nonnull String introspectionEndpoint)

    • getIntrospectionEndpoint

      @Nonnull public String getIntrospectionEndpoint()
      The public URL of the token introspection endpoint (RFC 7662). A caller authenticates and holds a token read scope; an ordinary client is refused.
      Returns:
      introspectionEndpoint

    • setIntrospectionEndpoint

      public void setIntrospectionEndpoint(@Nonnull String introspectionEndpoint)

    • revocationEndpoint

      public AuthorizationServerMetadata revocationEndpoint(@Nonnull String revocationEndpoint)

    • getRevocationEndpoint

      @Nonnull public String getRevocationEndpoint()
      The public URL of the token revocation endpoint (RFC 7009). A client authenticates and revokes its own tokens; any other token answers 200 and is left as it is.
      Returns:
      revocationEndpoint

    • setRevocationEndpoint

      public void setRevocationEndpoint(@Nonnull String revocationEndpoint)

    • dpopSigningAlgValuesSupported

      public AuthorizationServerMetadata dpopSigningAlgValuesSupported(@Nonnull List<AuthorizationServerMetadata.DpopSigningAlgValuesSupportedEnum> dpopSigningAlgValuesSupported)

    • addDpopSigningAlgValuesSupportedItem

      public AuthorizationServerMetadata addDpopSigningAlgValuesSupportedItem(AuthorizationServerMetadata.DpopSigningAlgValuesSupportedEnum dpopSigningAlgValuesSupportedItem)

    • getDpopSigningAlgValuesSupported

      @Nonnull public List<AuthorizationServerMetadata.DpopSigningAlgValuesSupportedEnum> getDpopSigningAlgValuesSupported()
      The JWS algorithms a DPoP proof may be signed with (RFC 9449 §5.1) when an administrative workload requests a DPoP-bound token.
      Returns:
      dpopSigningAlgValuesSupported

    • setDpopSigningAlgValuesSupported

      public void setDpopSigningAlgValuesSupported(@Nonnull List<AuthorizationServerMetadata.DpopSigningAlgValuesSupportedEnum> dpopSigningAlgValuesSupported)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • validateJsonElement

      public static void validateJsonElement(com.google.gson.JsonElement jsonElement) throws IOException
      Validates the JSON Element and throws an exception if issues found
      Parameters:
      jsonElement - JSON Element
      Throws:
      IOException - if the JSON Element is invalid with respect to AuthorizationServerMetadata

    • validateJsonElementAsCandidate

      public static void validateJsonElementAsCandidate(com.google.gson.JsonElement jsonElement) throws IOException
      Validates the JSON Element as a candidate of a oneOf schema: the checks of validateJsonElement(JsonElement), and the element carries no member this model does not declare. A oneOf schema without a discriminator tells its candidates apart by their member sets, so a candidate is matched on its closed member set.
      Parameters:
      jsonElement - JSON Element
      Throws:
      IOException - if the JSON Element is not a AuthorizationServerMetadata

    • fromJson

      public static AuthorizationServerMetadata fromJson(String jsonString) throws IOException
      Create an instance of AuthorizationServerMetadata given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of AuthorizationServerMetadata
      Throws:
      IOException - if the JSON string is invalid with respect to AuthorizationServerMetadata

    • toJson

      public String toJson()
      Convert an instance of AuthorizationServerMetadata to an JSON string
      Returns:
      JSON string