Interface EquinixCredentials

All Known Implementing Classes:
BasicEquinixCredentials
public interface EquinixCredentials
Represents credentials for authenticating with the Equinix Platform APIs.

Implementations of this interface provide the OAuth2 client credentials (Client ID and Client Secret) required for API authentication. The SDK uses these credentials to obtain and manage OAuth2 access tokens automatically.

Implementations need only supply the two getters below. The instance itself is never serialized onto the wire - the SDK builds a dedicated Oauth2TokenRequest from getAccessKey()/getSecretKey() when authenticating - so custom implementations (records, vault-backed classes, etc.) require no Jackson annotations.

Author:
ianjones
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAccessKey()
    Returns the OAuth2 Client ID (access key) for API authentication.
    String
    getSecretKey()
    Returns the OAuth2 Client Secret (secret key) for API authentication.

  • Method Details

    • getAccessKey

      String getAccessKey()
      Returns the OAuth2 Client ID (access key) for API authentication.
      Returns:
      the client ID string

    • getSecretKey

      String getSecretKey()
      Returns the OAuth2 Client Secret (secret key) for API authentication.
      Returns:
      the client secret string