OAuth 2.0 and OIDC: Refreshing of an Access Token
An access token is valid for a specific period of time, which is specified in the response
that returns the access token. When the access token expires, the client application can
request a new access token by providing the refresh token to the token endpoint. To request
a new access token, the client application should use the POST
method. The
following sections provide details on the request and the response.
HTTP Method and URL
POST
HTTP method. The client application can use one of the following approaches for the URL:- If the client application supports OpenID Connect
Discovery, the client application can use the discovery endpoint address, as shown in
the following code.
https://<MYOB Acumatica instance URL>/identity/.well-known/openid-configuration
Note:We recommend that the client application use the discovery endpoint address, which eliminates the need to change the application if the target endpoint address changes. - The client application can directly use the token
endpoint address, as shown in the following code.
https://<MYOB Acumatica instance URL>/identity/connect/token
HTTP Header
To refresh an access token, you use the following HTTP header.
Key | Value |
---|---|
Content-Type |
application/x-www-form-urlencoded |
Request Body
To refresh an access token, you specify the following parameters in the request body.
Parameter | Description |
---|---|
grant_type | The type of the request, which must be set to refresh_token
for the request of the refresh token. |
client_id |
The client ID that was assigned to the client application during the registration of the application in MYOB Acumatica. The client ID must have the format in which the ID was generated during the registration of the application. That is, the client ID must include an auto-generated string and the ID of the tenant, such as 88358B02-A48D-A50E-F710-39C1636C30F6@MyTenant. The client application will have access to the data of the tenant specified in the client ID. |
client_secret |
For a client application that uses a shared secret, the value of the secret that was created for the client application during the registration of the application in MYOB Acumatica. |
client_assertion_type | For a client application that uses JSON Web Token (JWT) bearer tokens, the client assertion type, which must be set to urn:ietf:params:oauth:client-assertion-type:jwt-bearer. |
client_assertion | For a client application that uses JSON Web Token (JWT) bearer tokens, a single JWT. |
refresh_token | The refresh token that the client application received from the token endpoint along with the access token if a user granted the offline_access scope to the client application. |
Response Body
MYOB Acumatica verifies the provided application credentials and issues the new access token and the new refresh token. To request the access token once again, the client application should use the latest issued refresh token. That is, if the client application has received a new refresh token, the client application should discard the previous refresh token and use the new one.
Parameter | Description |
---|---|
token_type | The type of the access token, which is Bearer. |
access_token | The new access token. |
expires_in | The period of time (in seconds) during which the access token is valid. |
scope |
The scope for which the access token and ID token are provided. The returning of this parameter is optional. |
refresh_token | The new refresh token. |
id_token |
The ID token associated with the authenticated session. The ID token contains three parts, which are separated by periods. The parts are Base64 encoded. The second part contains the claims to which the user granted access. For details on the ID token structure, see https://openid.net/specs/openid-connect-core-1_0.html#IDToken and https://www.rfc-editor.org/rfc/rfc7519.html. We recommend that you use the existing standard libraries for parsing the tokens. The parameter is returned only if the openid scope was granted. |