Package org.forgerock.openig.fapi.apiclient

Class ApiClient

java.lang.Object
org.forgerock.openig.fapi.apiclient.ApiClient
public final class ApiClient extends Object
Data object which represents a registered OAuth2.0 client.

Contains client registration information and a method for retrieving the client's JWKS in order to access the client's public keys (to validate JWS signatures and for mTLS checks).

Use ApiClient.ApiClientBuilder to create an instance.

  • Method Details

    • builder

      public static ApiClient.ApiClientBuilder builder()
      Create a new ApiClient.ApiClientBuilder.
      Returns:
      new ApiClient.ApiClientBuilder

    • getOAuth2ClientId

      public String getOAuth2ClientId()
      Get the OAuth2 client_id.
      Returns:
      the OAuth2 client_id

    • getSoftwareId

      public String getSoftwareId()
      Get the software_id.
      Returns:
      the software_id

    • getClientName

      public String getClientName()
      Get the client name.
      Returns:
      the client name

    • getSoftwareStatementAssertion

      public SignedJwt getSoftwareStatementAssertion()
      Get the Software Statement Assertion.
      Returns:
      the Software Statement Assertion

    • getOrganisation

      public ApiClientOrganisation getOrganisation()
      Get the organisation.
      Returns:
      the organisation

    • getRoles

      public List<String> getRoles()
      Get the roles.
      Returns:
      the roles

    • isDeleted

      public boolean isDeleted()
      Check if the ApiClient has been deleted.
      Returns:
      deleted flag

    • getJwkSetSecretStore

      public Promise<JwkSetSecretStore,FailedToLoadJWKException> getJwkSetSecretStore()
      Get the JwkSetSecretStore belonging to the client. This can be used to verify signatures of JWTs produced by this client.
      Returns:
      the JwkSetSecretStore belonging to the client

    • toString

      public String toString()
      Overrides:
      toString in class Object