Use Refresh Token for Access Token extension

Purpose

This method is designed to refresh Access tokens to extend the access_token lifetime

Specification

Link	https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/oauth/use-refresh-token-for-access-token-extension
Resource	/oauth/tokens
Scope	API paragraph not found
Components	Auth
Using Dictionaries	API paragraph not found
Using Microservices	API paragraph not found
Protocol type	REST
Request type	POST
Sync/Async	Sync

Logic

Preconditions

API paragraph not found

Global and configuration parameters

API paragraph not found

Input parameters

Attributes

Token:

Attribute	Type	Description	Example
client_id (required)	String	Medical Service provider ID issued after legal_entity registration. Used to identify the context of the MSP/Pharmacy	6498d88e-97fb-47e2-85a5-99e884f888aa
client_secret (required)	String	Medical Service provider secret key issued upon integration request. Used to identify MSP	msp-001-secret-key
refresh_token (required)	String	oAuth refresh token	my-oauth-refresh-token
grant_type (required)	String	oAuth Grant Type. Currently only `authorization_code` is supported	refresh_token

Filters

None

Request structure

See on Apiary

Example

Request example

curl --include \
     --request POST \
     --header "Content-Type: application/json" \
     --data-binary "{
  \"token\": {
    \"client_id\": \"6498d88e-97fb-47e2-85a5-99e884f888aa\",
    \"client_secret\": \"msp-001-secret-key\",
    \"refresh_token\": \"my-oauth-refresh-token\",
    \"grant_type\": \"refresh_token\"
  }
}" \
'http://ehealth.com/oauth/tokens'

Authorize

API paragraph not found

Headers

Example

Header example

Content-Type: application/json

Validate request (JSON schema)

API paragraph not found

Validation data request

API paragraph not found

Processing

API paragraph not found

Response structure

See on Apiary

Example:

{
  "meta": {
    "code": 201,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": {
    "value": "SnNRdCtvU0tTOENBV2dLRUZwNmIzZz09",
    "user_id": "3ff33ced-69dc-415a-b231-c6446898335a",
    "name": "change_password_token",
    "id": "3ff33ced-69dc-415a-b231-c6446898335a",
    "expires_at": 1498749591,
    "details": {
      "scope": "capitation_contracts:view capitation_contracts:create patients:view patients:create",
      "grant_type": "refresh_token",
      "client_id": "d290f1ee-6c54-4b01-90e6-d701748f0851"
    }
  }
}

Post-processing processes

API paragraph not found

HTTP status codes

HTTP status code	Message	What caused the error
201

Backward compatibility

API paragraph not found