Package se.curity.identityserver.sdk.oauth

Interface OAuthClient

public interface OAuthClient
An OAuth client.
Since:
4.0.0

  • Method Details

    • getId

      String getId()
      Returns:
      the ID of the client

    • isPublic

      boolean isPublic()
      Indicates whether or not the client is a public client. A public client is one that does not have a credential (i.e., a secret or other form of authentication). In this configuration, this is a client with the "no-authentication" verifier option selected.
      Returns:
      true if the client is a public one; false otherwise.
      Since:
      4.4.0

    • getClientIdentifier

      ClientIdentifier getClientIdentifier()
      Returns:
      the client identifier information

    • getScopeMap

      ScopeMap getScopeMap()
      Returns:
      a Map of scopes that this client is allowed to request.

    • getClaimSet

      ClaimSet getClaimSet()
      Returns:
      the Set of claims this client is allowed to request.

    • getProperties

      @Deprecated(since="7.1") Map<String,String> getProperties()
      Deprecated.
      use getTypedProperties() instead.
      Returns:
      the stringly-typed properties associated with this client. If this is a DCR dynamic client, notice that this method will return the JSON-serialized version of each property value.

    • getTypedProperties

      Map<String,?> getTypedProperties()
      Returns:
      the properties associated with this client. Static configuration clients can only have String property values. Dynamic clients (DCR) may have properties with any type. Notice that custom DCR client attributes (i.e. non-schematic attributes) are available as properties.
      Since:
      7.1

    • getSecret

      Optional<String> getSecret()
      Returns:
      an optional secret for the client.

    • getName

      Optional<String> getName()
      Returns:
      an optional human readable name of the client

    • getDescription

      Optional<String> getDescription()
      Returns:
      an optional description of the client

    • getRedirectUris

      List<URI> getRedirectUris()
      Returns:
      redirect URIs

    • requiresUserConsent

      boolean requiresUserConsent()
      Returns:
      whether this client requires consent of the resource owner.

    • allowConsentDeselection

      boolean allowConsentDeselection()
      A flag that indicates that the user is allowed to deselect optional individual scopes or claims when asked for consent.
      Returns:
      true if the user can deselect entries on the consent page; false otherwise.

    • getAudiences

      Set<String> getAudiences()
      Returns:
      the audiences of this client.

    • getLogoUri

      Optional<URI> getLogoUri()
      Returns:
      the client's Logo URL

    • getTermsOfServiceUri

      Optional<URI> getTermsOfServiceUri()
      Returns:
      the client's Terms Of Service URL

    • getPolicyUri

      Optional<URI> getPolicyUri()
      Returns:
      the client's Privacy Policy URL

    • getDelegationTimeToLive

      long getDelegationTimeToLive()
      Returns:
      the default time-to-live, in seconds, for delegations issued with this client.

    • getAccessTokenTimeToLive

      long getAccessTokenTimeToLive()
      Returns:
      the default time-to-live, in seconds, for access tokens issued with this client.

    • getIdTokenTimeToLive

      long getIdTokenTimeToLive()
      Returns:
      the default time-to-live, in seconds, for ID tokens issued with this client.

    • getRefreshTokenTimeToLive

      long getRefreshTokenTimeToLive()
      Returns:
      the default time-to-live, in seconds, for refresh tokens issued with this client.

    • getScopeNames

      default Set<String> getScopeNames()
      Returns:
      the names of the scopes this client may utilize. May include prefix scopes.

    • getIdTokenIssuer

      String getIdTokenIssuer()
      Returns:
      the ID of the token issuer for issuing ID tokens with this client.
      Since:
      7.0