Equinix API Authentication | Equinix Product Documentation

Generate New Access Token

Request

This API handles authentication and authorization of the API developer. It returns an access_token which would be valid for 60 minutes. The user account will get locked after 5 successive invalid attempts.

Bodyapplication/jsonrequired

Request token json payload

user_namestring

Deprecated - The Equinix username used to access portals

user_passwordstring

Deprecated - The Equinix user password used to access portals

client_idstringrequired

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

client_secretstringrequired

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

grant_typestring

The OAuth2 grant type used for authorization. Supported values are "password" & "client_credentials". user_name and password is not considered in case this value is "client_credentials". If the grant_type is not passed, by default it would consider "password" type in which user_name and password is required. Note that the password grant type is deprecated. Recommended to use grant_type of 'client_credentials' instead.

password_encodingstring

For enhanced security, you may encrypt the password value while requesting for an access_token. Currently only "md5-b64" hashing is supported. Any other value would treat password value as raw string

Default:"none"

Payload

{
  "user_name": "string",
  "user_password": "string",
  "client_id": "string",
  "client_secret": "string",
  "grant_type": "string",
  "password_encoding": "none"
}

Responses

Successful 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)"
}