This endpoint generates a new authentication token based on the provided refresh token.
\nAuthorized roles:
\nThe previously-issued refresh token.
" } ], "modelRef": "#/components/schemas/CustomerRefreshToken", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "LoggedIn", "name": "LoggedIn", "kind": "optional", "type": "http", "description": "The presence of this token indicates that the user is a known consumer that has previously logged into the platform.", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Success-authentication token generated.
", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "This the body of information returned when a consumer is successfully able to authenticate.", "customType": "CustomerLoginDone", "schema": [ { "name": "accessToken", "kind": "required", "type": "string", "description": "This is a JWT token containing the relevant authentication information." }, { "name": "refreshToken", "kind": "optional", "type": "string", "description": "This is a token that can be used to refresh the validity of the access token." } ], "modelRef": "#/components/schemas/CustomerLoginDone", "isExpanded": true } ] }, { "statusCode": "400", "description": "The request contained information that the server was unable to process. Appropriate errors are provided in the response body.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ValidationErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ValidationErrorResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "BqZwBm97uVDupfzatDC-U", "language": "curl", "label": "cURL", "code": "curl --request PUT \\\n --url https://api.upstartcommerce.com/v1/customer/profile/refresh/token \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --header 'x-upstart-tenant: string' \\\n --data '{\n \"refreshToken\": \"\"\n }'" }, { "id": "0XZ6tltED4B-DYFjs6tIk", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-upstart-tenant\", \"string\");\n\nvar raw = JSON.stringify({\n \"refreshToken\": \"\"\n});\n\nvar requestOptions = {\n method: 'PUT',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.upstartcommerce.com/v1/customer/profile/refresh/token\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "mHZnCjt_pBtx2XwmZccQv", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/v1/customer/profile/refresh/token\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Put.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-upstart-tenant\"] = \"string\"\nrequest.body = JSON.dump({\n \"refreshToken\": \"\"\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "U-LFEJM_WEeiok38LD67L", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/v1/customer/profile/refresh/token\"\n\npayload = json.dumps({\n \"refreshToken\": \"\"\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-upstart-tenant': 'string'\n}\n\nresponse = requests.request(\"PUT\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "BqZwBm97uVDupfzatDC-U" }, "results": { "languages": [ { "id": "BVhekO-YqdqpnrRwEz2qB", "language": "200", "code": "// Success-authentication token generated.\n{\n \"accessToken\": \"\",\n \"refreshToken\": \"\"\n}" }, { "id": "O39Jqrl8TL5yNhaIA7PsH", "language": "400", "code": "// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n}" }, { "id": "_b-DBJfCKxfTDUhtZX9Ku", "language": "401", "code": "// The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" } ], "selectedLanguageId": "BVhekO-YqdqpnrRwEz2qB" } }, "children": [ { "text": "" } ] }