Skip to content

Latest commit

 

History

History
88 lines (59 loc) · 2.73 KB

RefreshTokenApi.md

File metadata and controls

88 lines (59 loc) · 2.73 KB

workplace_client.RefreshTokenApi

All URIs are relative to https://workplace-console.truehost.cloud/api

Method HTTP request Description
refresh_token_create POST /refresh-token/ Refresh authentication token

refresh_token_create

TokenRefresh refresh_token_create(token_refresh)

Refresh authentication token

Takes a refresh type JSON web token and returns an access type JSON web token if the refresh token is valid.

Example

  • Bearer (JWT) Authentication (BearerAuth):
import workplace_client
from workplace_client.models.token_refresh import TokenRefresh
from workplace_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://workplace-console.truehost.cloud/api
# See configuration.py for a list of all supported configuration parameters.
configuration = workplace_client.Configuration(
    host = "https://workplace-console.truehost.cloud/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): BearerAuth
configuration = workplace_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with workplace_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = workplace_client.RefreshTokenApi(api_client)
    token_refresh = workplace_client.TokenRefresh() # TokenRefresh | 

    try:
        # Refresh authentication token
        api_response = api_instance.refresh_token_create(token_refresh)
        print("The response of RefreshTokenApi->refresh_token_create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RefreshTokenApi->refresh_token_create: %s\n" % e)

Parameters

Name Type Description Notes
token_refresh TokenRefresh

Return type

TokenRefresh

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 Token refreshed -

[Back to top] [Back to API list] [Back to Model list] [Back to README]