Package api.equinix.javasdk.core.auth

Class BasicEquinixCredentials

java.lang.Object

api.equinix.javasdk.core.auth.BasicEquinixCredentials

All Implemented Interfaces:

EquinixCredentials

public class BasicEquinixCredentials
extends Object
implements EquinixCredentials

Standard implementation of EquinixCredentials using OAuth2 client credentials.

This is the primary way to authenticate with Equinix Platform APIs. Provide your Client ID and Client Secret obtained from the Equinix Developer Portal.

Usage

 BasicEquinixCredentials credentials = new BasicEquinixCredentials("clientId", "clientSecret");
 Fabric fabric = new Fabric(credentials);
 

Version:

$Id: $Id

Author:

ianjones

Constructor Summary

Constructors

Constructor	Description
BasicEquinixCredentials(String accessKey, String secretKey)	Creates credentials using the given OAuth2 Client ID and Client Secret.

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BasicEquinixCredentials

public BasicEquinixCredentials(String accessKey,
 String secretKey)

Creates credentials using the given OAuth2 Client ID and Client Secret.

Parameters:

accessKey - the OAuth2 Client ID from the Equinix Developer Portal

secretKey - the OAuth2 Client Secret from the Equinix Developer Portal

Method Details

getAccessKey

public String getAccessKey()

Returns the OAuth2 Client ID (access key) for API authentication.

Specified by:

getAccessKey in interface EquinixCredentials

Returns:

the client ID string

getSecretKey

public String getSecretKey()

Returns the OAuth2 Client Secret (secret key) for API authentication.

Specified by:

getSecretKey in interface EquinixCredentials

Returns:

the client secret string

getGrantType

public String getGrantType()

Returns the OAuth2 grant type. Always returns "client_credentials".

Returns:

the grant type string