Package ca.cdr.api.model.json

Interface IOAuth2ClientDetails

All Known Implementing Classes:
OAuth2ClientDetailsJson
public interface IOAuth2ClientDetails

  • Method Summary

    Modifier and Type
    Method
    Description
    Set<String>
    getAutoApproveScopes()
    Any scopes that will be automatically approved if the client requests them during authorization, without prompting the user.
    Set<String>
    getAutoGrantScopes()
    Any scopes that will be automatically granted to the client even if it does not request them.
    String
    getClientId()
    The client ID (used as a primary key, and as a parameter during auth exchange)
    String
    getClientName()
    The client's name (used only for display purposes, may be shown to end users)
    String
    getModuleId()
    The module ID that this client is registered against.
    String
    getNodeId()
    The node ID that this client is registered against.
    Long
    getPid()
    This PID (persistent ID) for this client.
    String
    getPublicJwks()
    The client's public JWKS
    Set<String>
    getRegisteredRedirectUri()
    Allowable redirect URIs the client can specify as a part of an auth exchange
    Set<String>
    getScope()
    Scopes that the client is allowed to request? Callers should not modify the returned collection.
    boolean
    isCreatedByAppSphere()
    Was this client created by AppSphere
    boolean
    isEnabled()
    Is the client enabled?
    boolean
    isSecretRequired()
    Does the client require a client secret in order to authenticate?

  • Method Details

    • getPid

      Long getPid()
      This PID (persistent ID) for this client. This is the internal database ID for the client and is globally unique across the smile CDR cluster.

    • getNodeId

      String getNodeId()
      The node ID that this client is registered against.

    • getModuleId

      String getModuleId()
      The module ID that this client is registered against.

    • getClientId

      @Nonnull String getClientId()
      The client ID (used as a primary key, and as a parameter during auth exchange)

    • getClientName

      @Nullable String getClientName()
      The client's name (used only for display purposes, may be shown to end users)

    • getRegisteredRedirectUri

      @Nonnull Set<String> getRegisteredRedirectUri()
      Allowable redirect URIs the client can specify as a part of an auth exchange

    • getScope

      @Nonnull Set<String> getScope()
      Scopes that the client is allowed to request? Callers should not modify the returned collection.

    • getAutoApproveScopes

      @Nonnull Set<String> getAutoApproveScopes()
      Any scopes that will be automatically approved if the client requests them during authorization, without prompting the user. Callers should not modify the returned collection.

    • getAutoGrantScopes

      @Nonnull Set<String> getAutoGrantScopes()
      Any scopes that will be automatically granted to the client even if it does not request them. Callers should not modify the returned collection.

    • isSecretRequired

      boolean isSecretRequired()
      Does the client require a client secret in order to authenticate?

    • isEnabled

      boolean isEnabled()
      Is the client enabled?

    • isCreatedByAppSphere

      boolean isCreatedByAppSphere()
      Was this client created by AppSphere

    • getPublicJwks

      @Nullable String getPublicJwks()
      The client's public JWKS