V1 Get Token REST Service for OAuth Authentication
GET /ws/rest/service/v1/oauth/token
Version: 21.7
Purpose
Use this REST service to generate an OAuth token to access V1 REST services.
Authorization
Use the OAuth type integration user and password reset using email.
Input Authorization
Username and password using Basic Authentication
All parameters should be URL encoded.
curl --location 'http://<HOST>/ws/rest/service/v1/oauth/token' \
--header 'Authorization: Basic XYZ'
Optional Request Parameter
Use the following parameter to modify the token expiration in the API request:
Request Parameter | Data Type | Description |
|---|---|---|
expiry | string | Enter the optional token expiration duration in seconds. For example, expiry=300. The default value is 3600 seconds. |
Response Format
A JSON object is returned containing 'status', 'data', and 'message'.
For a successful status (status code 200), the token details will be sent in the JSON output response.
If the status is not a success, a JSON object containing a 'message' is returned.
Sample Response
{
"access_token": "eyJ4NXQjUzI1NiIdds6IkRoQXRBNENzTDRUdEIza1BLRlY3TTZSUzlCbExBamIxbDBvV2V6OXpaUXMiLCJ4NXQiOiJXMlR2WXlBeTZZTEpUSndBRC1YdENRRXFmbnMiLCJraWQiOiJTSUdOSU5HX0tFWSIsImFsZyI6IlJTMjU2In0.eyJ1c2VyX3R6IjoiQW1lcmljYVwvQ2hpY2FnbyIsInN1YiI6Imp5b3RoaS5nYXR0dUBvcmFjbGUuY29tIiwidXNlcl9sb2NhbGUiOiJlbiIsInVzZXIudGVuYW50Lm5hbWUiOiJpZGNzLWM5YWFkYjYwZmJhMjRhN2RiYTU2N2NiZGM4NDRmYjUxIiwiaXNzIjoiaHR0cHM6XC9cL2lkZW50aXR5Lm9yYWNsZWNsb3VkLmNvbVwvIiwidXNlcl90ZW5hbnRuYW1lIjoiaWRjcy1jOWFhZGI2MGZiYTI0YTdkYmE1NjdjYmRjODQ0ZmI1MSIsImNsaWVudF9pZCI6IjlhZmI3MmY5OWFjMTQ1ZmY5MWUwYmEyMTg2ZjA3M2U5Iiwic3ViX3R5cGUiOiJ1c2VyIiwic2NvcGUiOiJ1cm46b3BjOmlkbTp0LnNlY3VyaXR5LmNsaWVudCIsImNsaWVudF90ZW5hbnRuYW1lIjoiaWRjcy1jOWFhZGI2MGZiYTI0YTdkYmE1NjdjYmRjODQ0ZmI1MSIsInJlZ2lvbl9uYW1lIjoidXMtYXNoYnVybi0xIiwidXNlcl9sYW5nIjoiZW4iLCJ1c2VyQXBwUm9sZXMiOlsiQXV0aGVudGljYXRlZCJdLCJleHAiOjE2MTk1OTQ5NTAsImlhdCI6MTYxOTU5NDc1MCwiY2xpZW50X2d1aWQiOiIxOGEwOGY4MTdiODM0ODllODc2M2FmMDYwYjEyNjdhYiIsImNsaWVudF9uYW1lIjoiSnlvdGhpVW5pZmllcl9SZXNvdXJjZUdyYW50IiwidGVuYW50IjoiaWRjcy1jOWFhZGI2MGZiYTI0YTdkYmE1NjdjYmRjODQ0ZmI1MSIsImp0aSI6IjExZWJhN2YyZjU4ZDYzMzRhYjM5YmZjNWM3ZmQyZjllIiwiZ3RwIjoicm8iLCJ1c2VyX2Rpc3BsYXluYW1lIjoiSnlvdGhpIEdhdHR1Iiwic3ViX21hcHBpbmdhdHRyIjoidXNlck5hbWUiLCJwcmltVGVuYW50Ijp0cnVlLCJ0b2tfdHlwZSI6IkFUIiwiY2FfZ3VpZCI6ImNhY2N0LWI2MWUxZmMyMjlkNTQ2ZDg4ODQ0NGMxMWE3ZTIzNzgwIiwiYXVkIjpbImh0dHBzOlwvXC9pZGNzLWM5YWFkYjYwZmJhMjRhN2RiYTU2N2NiZGM4NDRmYjUxLmlkZW50aXR5LmM5ZGV2Mi5vYzlxYWRldi5jb20iLCJodHRwczpcL1wvaWRjcy1jOWFhZGI2MGZiYTI0YTdkYmE1NjdjYmRjODQ0ZmI1MS51cy1hc2hidXJuLTEuc2VjdXJlLmlkZW50aXR5LmM5ZGV2Mi5vYzlxYWRldi5jb20iLCJ1cm46b3BjOmxiYWFzOmxvZ2ljYWxndWlkPWlkY3MtYzlhYWRiNjBmYmEyNGE3ZGJhNTY3Y2JkYzg0NGZiNTEiXSwidXNlcl9pZCI6Ijg2ZWMxNTE2MDUyYjRlNGI4ZTRkZDVjYzJhNDA2NGQ0IiwiY2xpZW50QXBwUm9sZXMiOlsiQXV0aGVudGljYXRlZCBDbGllbnQiXSwidGVuYW50X2lzcyI6Imh0dHBzOlwvXC9pZGNzLWM5YWFkYjYwZmJhMjRhN2RiYTU2N2NiZGM4NDRmYjUxLmlkZW50aXR5LmM5ZGV2Mi5vYzlxYWRldi5jb206NDQzIn0.exvW4qPZDf6oGJKp71ZNggSLZ44G4dKS5f53QfeTp1HDzldili0PdETspZxyDA1IkhVzTFfMjFI1-V6MOTPHMxplMiMXC3gGA_23_p-ZLEVTssub09NeIx3CCuOraIS1lo8c3T5W8x_H_ZQyHYyOnr8FGMczwbvSZZ0Iwlcusf9DLUFxAWnBq25y0FfJ2z6S8TthZqRo6vo0_PqtkuiskmG6Ig48JW2m038jfIsrve7ZYAoB-eWAGE5xfuVkYwD4s5mtDQnNldQpsoOQilSGBb51s_KxSAv5mbvmeHg8omVHTHtOmVfDXfEbVlZE5ccdSy5w_yWT3Egxv-uFxo8MLdiQ",
"token_type": "Bearer",
"expires_in": 3600,
"status": 200
}
Last Published Tuesday, July 1, 2025