Equinix API Authentication | Equinix Product Documentation

OAuth2 Token

Operations

Renew Access Tokens

Request

Use this API to refresh an access token using its refresh token. A valid refresh token is needed to retrieve a new access_token.

Bodyapplication/jsonrequired

Refresh token json payload.

client_idstringrequired

API Consumer Key available under "My Apps" in developer portal

client_secretstringrequired

API Consumer secret available under "My Apps" in developer portal

refresh_tokenstringrequired

The OAuth2 refresh_token retrieved from the previous successful Access Token API call

Payload

{
  "client_id": "string",
  "client_secret": "string",
  "refresh_token": "string"
}

Responses

Successful refresh Oauth2 token

Bodyapplication/json

access_tokenstringrequired

the OAuth2 Bearer token required to access Equinix API's

token_timeoutstringrequired

The max validity in seconds for this access_token

Default:"3599 (60 minutes)"

user_namestringrequired

The Equinix user account to which this token is associated with

token_typestringrequired

The type of access_token returned in this response

Default:"Bearer"

refresh_tokenstring

The OAuth2 refresh token which could be used to retrieve a new access_token without user credentials. The refresh_token has a max validity of 60 days after which a new Access Token request must be made. Refresh token is Not returned for "client_credentials" grant type

refresh_token_timeoutstring

The max validity in seconds for the refresh_token. This field is not retruned for the "client_credentials" grant type

Default:"5182560 (60 days)"

Response

{
  "access_token": "string",
  "token_timeout": "3599 (60 minutes)",
  "user_name": "string",
  "token_type": "Bearer",
  "refresh_token": "string",
  "refresh_token_timeout": "5182560 (60 days)"
}