Endpoint
/auth/oauth/token

Post the following information to get an OAuth 2.0 Access Token.

  • grant_type: client_credentials. APIs use Client Credentials Grant type.
  • client_id: key from the integration.
  • client_secret: secret from the integration.

client_id
string

This is the key from the integration.

client_secret
string

This is the secret from the integration.

grant_type
string

grant_type. Use client_credentials.

{
  "client_id": "jreMFqYUSytrutrii",
  "client_secret": "PCDNfgkhkjhleyreutyiytoiyuouyo9gp88",
  "grant_type": "client_credentials"
}

Responses

OK

access_token
string

The Access Token

expires_in
string

Seconds(s) to token expiry.OpsRamp's API Tokens expire in 7200s - 1s = 6199s

scope
string

OAuth 2.0 scope: All APIs use the same scope: global:manage.

token_type
string

The token_type: bearer

{
  "access_token": "6b4a5f03-7d49-4915-9792-2d964806cbd1",
  "expires_in": "7199",
  "scope": "global:manage",
  "token_type": "bearer"
}

Bad Request

error
string

error_description
string

{
  "error": "unsupported_grant_type",
  "error_description": "Unsupported grant type: user_password"
}

Unauthorized.

error
string

error_description
string

{
  "error": "unauthorized",
  "error_description": "Bad API credentials"
}