Documentation | Support

Go to the table of contents Go to the previous page Go to the next page View or print as PDF
Authentication > Refresh Token API
Refresh Token API
The refresh token API retrieves the refresh token (JWT) that is used for the application REST API authentication.
POST https://<DLP Manager IP>:<DLP Manager port>/dlp/rest/v1/auth/refresh-token
In this section:
*
Header parameters for the refresh token API
*
Request example for the refresh token API
*
Response for the refresh token API example
*
Status and error codes for the refresh token API
Header parameters for the refresh token API
The following two header parameters are required: username and password.
 
Parameter
username
Valid Values
The administrator account user name in Forcepoint DLP.
Example
username: <your Forcepoint DLP Admin application username>
 
Parameter
password
Valid Values
The administrator account password in Forcepoint DLP. The password is passed through HTTPS, so it does not need to be encrypted or encoded.
Example
password: <your Forcepoint DLP Admin application password>
Request example for the refresh token API
A full request is not sent for this API. Only the header parameters are sent in the request.
curl --location --request POST 'https://<DLP Manager IP>:<DLP Manager port>/dlp/rest/v1/auth/refresh-token' \
--header 'username: <username> '\
--header 'password: <password> '
Response for the refresh token API example
{
"refresh_token": "<refresh token>",
"refresh_expires_in": <expiration value>
"access_token": "<access token>",
"access_expires_in": <expiration_value>,
"token_type": "JWT"
}
Status and error codes for the refresh token API
 
Code
Message
200
Success
403
Forbidden (authentication failed)

Go to the table of contents Go to the previous page Go to the next page View or print as PDF
Authentication > Refresh Token API
Copyright 2022 Forcepoint. All rights reserved.