Skip to main content
POST
/
oauth
/
token
import cobo_waas2
from cobo_waas2.models.refresh_token2_xx_response import RefreshToken2XXResponse
from cobo_waas2.models.refresh_token_request import RefreshTokenRequest
from cobo_waas2.rest import ApiException
from pprint import pprint

# See configuration.py for a list of all supported configurations.
configuration = cobo_waas2.Configuration(
    # Replace `<YOUR_PRIVATE_KEY>` with your private key
    api_private_key="<YOUR_PRIVATE_KEY>",
    # Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2.
    host="https://api.dev.cobo.com/v2",
)
# Enter a context with an instance of the API client
with cobo_waas2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cobo_waas2.OAuthApi(api_client)
    refresh_token_request = cobo_waas2.RefreshTokenRequest()

    try:
        # Refresh Org Access Token
        api_response = api_instance.refresh_token(refresh_token_request)
        print("The response of OAuthApi->refresh_token:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OAuthApi->refresh_token: %s\n" % e)


{
  "access_token": "AnCEPEp5Q8qjAOA1Lb6kVd2OlkCyJnMTeMPdLbPOM8cz176Eb5y7EJoUjJJ0vkzz",
  "token_type": "Bearer",
  "scope": "",
  "expires_in": 43199,
  "refresh_token": "rK49jI0zt49gsttzscscik15Asmlpu1TdcxqguJJS8B9f6ilJEC0y3PbVqwsEAw5"
}
import cobo_waas2
from cobo_waas2.models.refresh_token2_xx_response import RefreshToken2XXResponse
from cobo_waas2.models.refresh_token_request import RefreshTokenRequest
from cobo_waas2.rest import ApiException
from pprint import pprint

# See configuration.py for a list of all supported configurations.
configuration = cobo_waas2.Configuration(
    # Replace `<YOUR_PRIVATE_KEY>` with your private key
    api_private_key="<YOUR_PRIVATE_KEY>",
    # Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2.
    host="https://api.dev.cobo.com/v2",
)
# Enter a context with an instance of the API client
with cobo_waas2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cobo_waas2.OAuthApi(api_client)
    refresh_token_request = cobo_waas2.RefreshTokenRequest()

    try:
        # Refresh Org Access Token
        api_response = api_instance.refresh_token(refresh_token_request)
        print("The response of OAuthApi->refresh_token:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OAuthApi->refresh_token: %s\n" % e)

Authorizations

​
BIZ-API-KEY
string
header
required

The API key. For more details, refer to API key.

In the API playground, enter your API secret, and your API key will be accordingly calculated.

Body

application/json

The request body for refreshing an Org Access Token.

​
client_id
string

The client ID, a unique identifier to distinguish Cobo Portal Apps. You can get the client ID by retrieving the manifest file after publishing the app.

Example:

"AnCEPEp5Q8qjAOA1Lb6kVd2OlkCyJnMTeMPdLbPOM8cz176Eb5y7EJoUjJJ0vkzz"

​
grant_type
string

The OAuth grant type. Set the value as refresh_token.

Example:

"refresh_token"

​
refresh_token
string

The Refresh Token of the current Org Access Token.

Example:

"rK49jI0zt49gsttzscscik15Asmlpu1TdcxqguJJS8B9f6ilJEC0y3PbVqwsEAw5"

Response

The request was successful.

​
access_token
string

The new Org Access Token.

Example:

"AnCEPEp5Q8qjAOA1Lb6kVd2OlkCyJnMTeMPdLbPOM8cz176Eb5y7EJoUjJJ0vkzz"

​
token_type
string

The type of the tokens, which is Bearer.

Example:

"Bearer"

​
scope
string

The scope of the Org Access Token to limit the app's access to the organization's resources. Note: Currently this property value is empty. The scope of the Org Access Token is based on the permissions granted when the app user installs the app.

Example:

""

​
expires_in
integer

The time in seconds in which the new Org Access Token expires.

Example:

43199

​
refresh_token
string

The Refresh Token, used to obtain another Org Access Token when the new Org Access Token expires. The expiration time for Refresh Tokens is currently set to 30 days and is subject to change.

Example:

"rK49jI0zt49gsttzscscik15Asmlpu1TdcxqguJJS8B9f6ilJEC0y3PbVqwsEAw5"