Refresh Token

Refresh Access tokens to make authenticated re quests for DLP APIs

Synopsis

URI
/v1/public/oauth/refreshToken
HTTP Method
POST

Description

A POST request to this endpoint refreshes the access token. Refresh tokens expire after 6 months.

Header Parameter

The parameters you can include in the endpoint query.
Field
Description
Authorization
(
Required
) Access token from the DLP app.

Request Fields

The body of this request contains a JSON object with the following fields:
Field
Description
refresh_token
(
Required
) Refresh Token from the DLP app.
Request Example
Request all results:
curl -L -X POST 'https://api.dlp.paloaltonetworks.com/v1/public/oauth/refreshToken' ^ -H 'Authorization: Bearer {TOKEN}' ^ -H 'Content-Type: application/json' ^ -d '{ "refresh_token" : "{REFRESH TOKEN}" }'

Success Response

Upon success, the HTTP response code is 200. In addition, this API returns a JSON object containing the query status, as well as an array of JSON objects, each of which represents a single incident.
Field
Description
access_token
New bearer token.
expires_in
Expiration time of the new bearer token.
Success Response Example
{ "access_token": "XVCIsInBpLmF0bSI6Ij.......", "token_type": "Bearer", "expires_in": "3599" }

Error Response

Upon error, the reply includes an HTTP response code, an error message, and additional information describing the error. The HTTP response code is one of the following:
Field
Description
400
Bad Request. Got an invalid JSON.
401
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, ID, or other invalid authentication parameters.
402
Unauthorized access. You do not have the required license type to run this API.
403
Forbidden access. The provided API Key does not have the required permissions to run this API.
415
Media Type not Accepted. Send request as JSON.
500
Internal server error. A unified status for API communication type errors.
Error Response Format
{"timestamp":1604344732485,"status":403,"error":"Forbidden","message":"","path":"/v1/public/oauth/refreshToken"}

Recommended For You