Package se.curity.identityserver.sdk.claims

Interface ClaimConfig

public interface ClaimConfig
A configured claim.
Since:
4.1.0

  • Method Details

    • getName

      String getName()
      Returns:
      the name of the claim

    • getDescription

      @Nullable @Nullable String getDescription()
      Returns:
      the description of this claim

    • isRequired

      boolean isRequired()
      Returns:
      whether this claim is a required claim

    • exposeInMetadata

      boolean exposeInMetadata()
      Returns:
      whether this claim should be exposed in server metadata

    • getProperties

      Map<String,String> getProperties()
      Returns:
      properties of this claim

    • getClaimsProviderId

      Optional<String> getClaimsProviderId()
      Returns:
      the ID of the claims provider that can resolve this claim, or empty to use the "none" claims provider
      Since:
      4.1.0

    • isConsentable

      boolean isConsentable()
      Returns:
      whether this is a consentable claim.
      Since:
      4.1.0

    • getInputAttributeNames

      Set<String> getInputAttributeNames()
      Returns:
      a collection of attribute names that are used as parameters to a transformation procedure
      Since:
      4.1.0

    • getValueTransformationScript

      @Nullable @Nullable String getValueTransformationScript()
      Returns:
      the script that takes the input attributes and transforms those into the value of this claim; when this value is null, input attributes may be empty, and the claim provider's attribute with the name of the claim will be used to establish the value of this claim.
      Since:
      4.1.0

    • isScopeRequired

      default @io.curity.java_to_ts_docs.annotations.TypescriptDocs("@returns `true` if, for it to be issued, this claim requires at least one of the scopes it\n is attached to to also be issued.") boolean isScopeRequired()
      Returns:
      true if, for it to be issued, this claim requires at least one of the scopes it is attached to to also be issued.
      Since:
      4.2.0

    • isSystemClaim

      boolean isSystemClaim()
      Returns:
      true if this is a system claim.
      Since:
      4.4.0