Security Token Service | Equinix Product Documentation

generate sts token

Request

An OAuth 2.0 token endpoint supporting RFC 8693 token exchange, used to exchange an OIDC ID token issued by a trusted OIDC provider to a trusted client for an access token that can be used access other Equinix product APIs.

Security

clientCredentials

Bodyapplication/x-www-form-urlencoded

grantTypestringrequired

The OAuth 2.0 grant type.

Enum:"client_credentials""urn:ietf:params:oauth:grant-type:token-exchange"

Example:"urn:ietf:params:oauth:grant-type:token-exchange"

scopestring

Requested scope for the access token.

Example:"accesspolicy:abc-123:idp:example-policy"

subjectTokenstring

The ID token to exchange.

Example:"eyJhbGciOiJSUzI1NiJ9..."

subjectTokenTypestring

The type of the subject token.

Value:"urn:ietf:params:oauth:token-type:id_token"

Example:"urn:ietf:params:oauth:token-type:id_token"

Payload

grantType=urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Atoken-exchange&scope=accesspolicy%3Aabc-123%3Aidp%3Aexample-policy&subjectToken=eyJhbGciOiJSUzI1NiJ9...&subjectTokenType=urn%3Aietf%3Aparams%3Aoauth%3Atoken-type%3Aid_token

Responses

Success

Bodyapplication/json

accessTokenstringrequired

The issued access token.

Example:"eyJhbGciOiJFUzI1NiJ9..."

issuedTokenTypestringrequired

The type of the issued token.

Value:"urn:ietf:params:oauth:token-type:access_token"

Example:"urn:ietf:params:oauth:token-type:access_token"

tokenTypestringrequired

The token type, e.g. Bearer.

Enum:"Bearer""DPoP"

Example:"Bearer"

expiresInintegerrequired

Lifetime of the token in seconds.

Example:3600

Response

{
  "accessToken": "eyJhbGciOiJFUzI1NiJ9...",
  "issuedTokenType": "urn:ietf:params:oauth:token-type:access_token",
  "tokenType": "Bearer",
  "expiresIn": 3600
}