Get Access Token

POST 
/

Use this endpoint to retrieve an access token for accessing the REST APIs.

Request

application/x-www-form-urlencoded

Body

grant_type string

Default value: client_credentials

Responses

200

Get Access Token - 200

Response Headers

• Alt-Svc

  string

• Via

  string

• content-length

  string

• date

  string

• x-request-id

  string

application/json

Schema

Schema

access_token string
api_product_list string
api_product_list_json string[]
application_name string
client_id string
developer.email string
expires_in string
issued_at string
organization_name string
refresh_count string
refresh_token_expires_in string
scope string
status string
token_type string

Example (from schema)

{
  "access_token": "ARAo4GjuI1bGSyenSKx5oYfFGuFQ",
  "api_product_list": "[Propeller REST APIs]",
  "api_product_list_json": [
    "Propeller REST APIs"
  ],
  "application_name": "a1ca275a-2abb-4bd3-82b0-3ae699d75e40",
  "client_id": "veNqlG9u5JAce1AccAnuiqxFL1NvVMHS0H8Qu8omHBW7ykjT",
  "developer.email": "developer@propel.us",
  "expires_in": "1899",
  "issued_at": "1646873717224",
  "organization_name": "propeller-platform-prod",
  "refresh_count": "0",
  "refresh_token_expires_in": "0",
  "scope": "",
  "status": "approved",
  "token_type": "BearerToken"
}

Get Access Token - 200

{
  "access_token": "ARAo4GjuI1bGSyenSKx5oYfFGuFQ",
  "api_product_list": "[Propeller REST APIs]",
  "api_product_list_json": [
    "Propeller REST APIs"
  ],
  "application_name": "a1ca275a-2abb-4bd3-82b0-3ae699d75e40",
  "client_id": "veNqlG9u5JAce1AccAnuiqxFL1NvVMHS0H8Qu8omHBW7ykjT",
  "developer.email": "developer@propel.us",
  "expires_in": "1899",
  "issued_at": "1646873717224",
  "organization_name": "propeller-platform-prod",
  "refresh_count": "0",
  "refresh_token_expires_in": "0",
  "scope": "",
  "status": "approved",
  "token_type": "BearerToken"
}

400

Get Access Token - 400 (invalid body value)

Response Headers

• Alt-Svc

  string

• Via

  string

• content-length

  string

• date

  string

• x-request-id

  string

application/json

Schema

Schema

Error string
ErrorCode string

Example (from schema)

{
  "Error": "Unsupported grant type : client_credentials1",
  "ErrorCode": "invalid_request"
}

Get Access Token - 400 (invalid body value)

{
  "Error": "Unsupported grant type : client_credentials1",
  "ErrorCode": "invalid_request"
}

401

Get Access Token - 401 (wrong client id / client secret)

Response Headers

• Alt-Svc

  string

• Via

  string

• content-length

  string

• date

  string

• x-request-id

  string

application/json

Schema

Schema

Error string
ErrorCode string

Example (from schema)

{
  "Error": "ClientId is Invalid",
  "ErrorCode": "invalid_client"
}

Get Access Token - 401 (wrong client id / client secret)

{
  "Error": "ClientId is Invalid",
  "ErrorCode": "invalid_client"
}

Loading...