V2 Get Token REST Service for OAuth Authentication

GET https://<hostname>/ws/rest/service/v2/auth/token

Purpose

Use this rest service with your credentials to fetch a JWT token to access V2 REST services. The token is valid for date/time available in the response. The token expiration is set to 3600 seconds by default.

Sample Request

Send an API request for a token with the end point URL included in the following curl command.

curl --location --request GET 'http://<HOST_NAME/ws/rest/service/v2/auth/token' \

--header 'Authorization: Bearer XXXXXXX'

Note: If the endpoint URL has a project number that contains special characters such as / \ : * ? " < > or |, you must change those special characters to URL escape characters. For example, a project number with a special number sign (hash) such as 2020#7 must be changed to 2020%7. You can use a browser to access the list of URL escape characters.

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.

Sample Success Response

{

"data": {

"access_token": "eyJ4NXQjUzI1NiI6IjN2dFl1OU04ejFJSWlieDI2c2k1b2J1ekZ4RlBlRFpTcmhjX01kcHpjcE0iLCJ4NXQiOiItZlVTYTJVeGNzRGxJUzBxbHRrT3c5cEtyNlUiLCJraWQiOiJTSUdOSU5HX0tFWSIsImFsZyI6IlJTMjU2In0.eyJjbGllbnRfb2NpZCI6Im9jaWQxLmRvbWFpbmFwcC5vYzEuaWFkLmFtYWFhYWFhYXF0cDViYWE1Z3Rwd25zbW5nbjY1eGdmcTIyZ3hsamFpeHpidWp3ZmVpNTY0Zmp5YjduYSIsInVzZXJfdHoiOiJBbWVyaWNhXC9DaGljYWdvIiwic3ViIjoiJCRtb2hhbmludCIsInVzZXJfbG9jYWxlIjoiZW4iLCJzaWRsZSI6NDgwLCJ1c2VyLnRlbmFudC5uYW1lIjoiaWRjcy1lOWEyZTBiMWU5MmU0MjQyYWQxM2Y4YWQ2OWJkNzk3ZiIsImlzcyI6Imh0dHBzOlwvXC9pZGVudGl0eS5vcmFjbGVjbG91ZC5jb21cLyIsImRvbWFpbl9ob21lIjoidXMtYXNoYnVybi0xIiwiY2Ffb2NpZCI6Im9jaWQxLnRlbmFuY3kub2MxLi5hYWFhYWFhYXFoZTZzZ2Y0bnNsbjdyNDN2eXVhbHVwY21nZnBuazZmaG54MzJuZmhhdWEzYnpjY2RoY2EiLCJ1c2VyX3RlbmFudG5hbWUiOiJpZGNzLWU5YTJlMGIxZTkyZTQyNDJhZDEzZjhhZDY5YmQ3OTdmIiwiY2xpZW50X2lkIjoiY2VnYnUtbXVtLTQxOV91bmlmaWVyX3d0c3NfYXBwX0FQUElEIiwiZG9tYWluX2lkIjoib2NpZDEuZG9tYWluLm9jMS4uYWFhYWFhYWF5bnVnc2NkNXZiMjRmNW50N2VkbTUzdnBteDZwbHFkamR3bDdsajJsZ3pmM3l4ZG0yNmFhIiwic3ViX3R5cGUiOiJ1c2VyIiwic2NvcGUiOiJ1cm46b3BjOmlkbTp0LnNlY3VyaXR5LmNsaWVudCIsInVzZXJfb2NpZCI6Im9jaWQxLnVzZXIub2MxLi5hYWFhYWFhYW9ja3p5c2V0YXQ0eXR1cnJ6bnVsYXFiaDZuaHc0NnFreDRsY2NmaXJxcWI1ZGEzYjNwbGEiLCJjbGllbnRfdGVuYW50bmFtZSI6ImlkY3MtZTlhMmUwYjFlOTJlNDI0MmFkMTNmOGFkNjliZDc5N2YiLCJyZWdpb25fbmFtZSI6InVzLWFzaGJ1cm4tMSIsInVzZXJfbGFuZyI6ImVuIiwidXNlckFwcFJvbGVzIjpbIkF1dGhlbnRpY2F0ZWQiXSwiZXhwIjoxNjk1OTEyMzY2LCJpYXQiOjE2OTU5MDg3NjYsImNsaWVudF9ndWlkIjoiMDUxMjhlMmMwZDZjNDY3MTlhMzY5NTQ5MTk3YzM5NDAiLCJjbGllbnRfbmFtZSI6ImNlZ2J1LW11bS00MTlfdW5pZmllcl93dHNzX2FwcCIsInRlbmFudCI6ImlkY3MtZTlhMmUwYjFlOTJlNDI0MmFkMTNmOGFkNjliZDc5N2YiLCJqdGkiOiI3NWExYzEyMmU1ZjQ0ZjExODc1MTIzODgyNTRkMzkzMCIsImd0cCI6InJvIiwidXNlcl9kaXNwbGF5bmFtZSI6Ik1vaGFuIEQiLCJvcGMiOnRydWUsInN1Yl9tYXBwaW5nYXR0ciI6InVzZXJOYW1lIiwicHJpbVRlbmFudCI6dHJ1ZSwidG9rX3R5cGUiOiJBVCIsImF1ZCI6WyJodHRwczpcL1wvaWRjcy1lOWEyZTBiMWU5MmU0MjQyYWQxM2Y4YWQ2OWJkNzk3Zi51cy1hc2hidXJuLTEuc2VjdXJlLmlkZW50aXR5LnBpbnQub2M5cWFkZXYuY29tIiwidXJuOm9wYzpsYmFhczpsb2dpY2FsZ3VpZD1pZGNzLWU5YTJlMGIxZTkyZTQyNDJhZDEzZjhhZDY5YmQ3OTdmIiwiaHR0cHM6XC9cL2lkY3MtZTlhMmUwYjFlOTJlNDI0MmFkMTNmOGFkNjliZDc5N2YuaWRlbnRpdHkucGludC5vYzlxYWRldi5jb20iXSwiY2FfbmFtZSI6InVuaWZpZXJtdGRldiIsInVzZXJfaWQiOiJiZWU4ZmRmYTNiYjA0NDMyOTcxMDg2ZDUyMGQ4OWZmZSIsImRvbWFpbiI6IkRlZmF1bHQiLCJjbGllbnRBcHBSb2xlcyI6WyJBdXRoZW50aWNhdGVkIENsaWVudCIsIkNsb3VkIEdhdGUiXSwidGVuYW50X2lzcyI6Imh0dHBzOlwvXC9pZGNzLWU5YTJlMGIxZTkyZTQyNDJhZDEzZjhhZDY5YmQ3OTdmLmlkZW50aXR5LnBpbnQub2M5cWFkZXYuY29tOjQ0MyJ9.V05olhXu5B9J4cpNcCV4dSYIcfvcjM83Oybko3vJN7dCkCdGhEIUyZoD-sZAz8jGOIgwbWSQapiXoaClNk6Zn-_ZJz6JosCDeHFcLDcOUGsMSNJ2nHTxe7bUijTtzR2U2vegq_p5jpo9s8gRkXQeQLYHagiDmlN0zd9aAR6NZJcppOCh_cat6V7MMrGfMSDaxeUSVrUfkrNkMk4uZHNX0YhWljcD1Ox24ePKiPDh--yxXyomrf4w_aQkxVzGItsjJozAONLMtX1h-2Am00YeF5A2JYwtDs7a3U-__7wlCvWB-wTFyJtHuZUTNGmx-Ihx3QARNJgIVih5G9XLXrZfZg",

"expires_in": 3600,

"token_type": "Bearer",

"auth_type": "oAuth"

},

"message": [],

"status": 200

}

Supported Response Parameters for OAuth Authentication

The following parameters display with values in the response output:

Response Parameter	Data Type	Description
access_token	string	Displays the bearer token.
expires_in	string	Displays the expiry duration in seconds. By default, 3600 seconds.
token_type	string	Displays the Bearer token type.
auth_type	string	Displays the authentication type used by the integration user. Choices include: Basic, and OAuth.
message	string	Displays the error message.
status	string	Displays the http status code.

Supported HTTP Status Codes

The following HTTP status codes are supported for this rest service:

HTTP Status Code	Status Message	Error Message
200	Success	not applicable.
400	Bad Request	Invalid expiry.
401	Unauthorized	Empty or Invalid Authorization Header. Invalid Authorization Header
500	Internal Server Error	Please contact Administrator with Diagnostic code.

Supported HTTP Status Codes

Related Topics