Package io.fliqa.client.interledger.model

Class AccessToken

java.lang.Object
io.fliqa.client.interledger.model.AccessToken
public class AccessToken extends Object
Represents an access token granted by the authorization server.

This class contains the access token credentials that a client can use to access protected resources in the Interledger Open Payments ecosystem. The token includes the actual token value, management information, expiration details, and the specific access rights that have been granted.

Access tokens are used to authenticate and authorize API requests to protected resources. They are typically included in the Authorization header of HTTP requests using the GNAP (Grant Negotiation and Authorization Protocol) bearer token format.

Example usage: 

 Authorization: GNAP access_token_value
Since:
1.0
See Also:

  • Field Details

    • token

      public String token
      The access token value that should be used in API requests.

      This is the actual token string that the client must include in the Authorization header when making requests to protected resources. The token value is opaque to the client and should be treated as a credential.

      Example: "OS9M2PMHKUR64TB8N6BW7OZB8CDFONP219RP1LT0"

    • manage

      public URI manage
      The URI for managing this access token.

      This URI can be used by the client to perform management operations on the token such as refreshing, revoking, or checking the token status. The exact operations available depend on the authorization server's implementation.

      Example: "https://ilp.interledger-test.dev/gnap/token/12345"

    • expiresIn

      public Integer expiresIn
      Optional expiration time for the access token in seconds.

      This field indicates the lifetime of the token in seconds from the time of issuance. After this time, the token will no longer be valid and the client should obtain a new token.

      If not present, the token may have an indefinite lifetime or use the authorization server's default expiration policy.

      Example: 3600 (1 hour)

    • access

      public Set<AccessItem> access
      The specific access rights granted by this token.

      This set contains the detailed permissions that this token provides. Each access item specifies the type of resource, the actions that can be performed, and any limits or constraints on the access.

      The access rights determine what operations the client can perform with this token, such as creating payments, reading account information, or managing resources.

      See Also:

  • Constructor Details

    • AccessToken

      public AccessToken()