Web API: Token - Revision history

Ollvihe at 20:18, 25 August 2025

2025-08-25T20:18:07Z

← Older revision		Revision as of 20:18, 25 August 2025
Line 25:		Line 25:
	* '''globalPermissions''': [[Roles_and_Permissions#Mapping_Roles_and_Permissions\|Global permissions]] of the user as comma separated list.		* '''globalPermissions''': [[Roles_and_Permissions#Mapping_Roles_and_Permissions\|Global permissions]] of the user as comma separated list.
	* '''serverVersion''': Version of the QPR ProcessAnalyzer server.		* '''serverVersion''': Version of the QPR ProcessAnalyzer server.
			* '''effectiveDefaultDashboard''': Dashboard identifier of the user's starting dashboard (dashboard which opens when the user logs in). In case of no value, the user doesn't have a starting dashboard and the user will go to the Workspace after login.
	* '''token_type''': contains always "bearer"		* '''token_type''': contains always "bearer"
	* '''userSettings''': All user-specific settings in stringified JSON format. Contains the following settings:		* '''userSettings''': All user-specific settings in stringified JSON format. Contains the following settings:

Ollvihe at 17:36, 5 March 2023

2023-03-05T17:36:35Z

← Older revision		Revision as of 17:36, 5 March 2023
Line 9:		Line 9:
	</pre>		</pre>

	When using SAML 2.0 authentication, instead of the password, the url needs to have a ''samlhash'' parameter (value for it has been received earlier using [[Web_API:_saml2/acs\|/saml2/acs]]):		When using SAML 2.0 authentication, instead of the password, the url needs to have a ''samlhash'' parameter (value for it has been received earlier using [[Web_API:_saml2/acs\|/qprpa/saml2/acs]]):
	<pre>		<pre>
	Url: POST qprpa/token?samlHash=<samlhash>		Url: POST qprpa/token?samlHash=<samlhash>

Ollvihe at 17:36, 5 March 2023

2023-03-05T17:36:21Z

← Older revision		Revision as of 17:36, 5 March 2023
Line 9:		Line 9:
	</pre>		</pre>

	When using SAML 2.0 authentication, instead of the password, the url needs to have a ''samlhash'' parameter (value for it has been received earlier using [[Web_API:~~_Samlsignin~~\|/~~api~~/~~samlsignin~~]]):		When using SAML 2.0 authentication, instead of the password, the url needs to have a ''samlhash'' parameter (value for it has been received earlier using [[Web_API:_saml2/acs\|/saml2/acs]]):
	<pre>		<pre>
	Url: POST qprpa/token?samlHash=<samlhash>		Url: POST qprpa/token?samlHash=<samlhash>

Ollvihe at 08:07, 27 April 2022

2022-04-27T08:07:56Z

← Older revision		Revision as of 08:07, 27 April 2022
Line 1:		Line 1:
	Token operation ~~is used to login~~ a user, either using username and password, or as part of the [[SAML_2.0_Federated_Authentication\|SAML 2.0 authentication]] using the previously fetched ''samlhash''. An ''access token'' is returned as a response, which is used to identify the session in the following Web API interactions.		''Token'' operation logins a user, either using the username and password, or as part of the [[SAML_2.0_Federated_Authentication\|SAML 2.0 authentication]] using the previously fetched ''samlhash''. An ''access token'' is returned as a response, which is used to identify the session in the following Web API interactions.

	The token request is following:		The token request is following:
Line 5:		Line 5:
	Url: POST qprpa/token		Url: POST qprpa/token
	Content-Type: application/x-www-form-urlencoded		Content-Type: application/x-www-form-urlencoded
	Body (form data with username, password and grant_type ~~properties~~):		Body (form data with username, password and grant_type fields):
	username=myUserName&password=myPassword&grant_type=password		username=myUserName&password=myPassword&grant_type=password
	</pre>		</pre>
Line 16:		Line 16:
	Note that the path doesn't contain ''api'', unlike other operations in the Web API. Example url: <nowiki>https://customer.onqpr.com/qprpa/token</nowiki>.		Note that the path doesn't contain ''api'', unlike other operations in the Web API. Example url: <nowiki>https://customer.onqpr.com/qprpa/token</nowiki>.

	Request body contains the following parameters ~~as url~~ encoded:		Request body contains the following parameters (encoded with x-www-form-urlencoded):
	* '''username''': Login name of the user		* '''username''': Login name of the user
	* '''password''': User password (empty ~~when using~~ SAML 2.0 authentication)		* '''password''': User password (empty in SAML 2.0 authentication)
	* '''grant_type''': use always "password"		* '''grant_type''': use always text "password"

	The response contains the following fields:		The response contains the following fields:

Ollvihe at 23:32, 17 February 2022

2022-02-17T23:32:24Z

← Older revision		Revision as of 23:32, 17 February 2022
Line 3:		Line 3:
	The token request is following:		The token request is following:
	<pre>		<pre>
	Url: POST qprpa~~/api~~/token		Url: POST qprpa/token
	Content-Type: application/x-www-form-urlencoded		Content-Type: application/x-www-form-urlencoded
	Body (form data with username, password and grant_type properties):		Body (form data with username, password and grant_type properties):
Line 11:		Line 11:
	When using SAML 2.0 authentication, instead of the password, the url needs to have a ''samlhash'' parameter (value for it has been received earlier using [[Web_API:_Samlsignin\|/api/samlsignin]]):		When using SAML 2.0 authentication, instead of the password, the url needs to have a ''samlhash'' parameter (value for it has been received earlier using [[Web_API:_Samlsignin\|/api/samlsignin]]):
	<pre>		<pre>
	Url: POST qprpa~~/api~~/token?samlHash=<samlhash>		Url: POST qprpa/token?samlHash=<samlhash>
	</pre>		</pre>

Ollvihe at 23:32, 17 February 2022

2022-02-17T23:32:02Z

← Older revision		Revision as of 23:32, 17 February 2022
Line 3:		Line 3:
	The token request is following:		The token request is following:
	<pre>		<pre>
	Url: POST api/token		Url: POST qprpa/api/token
	Content-Type: application/x-www-form-urlencoded		Content-Type: application/x-www-form-urlencoded
	Body (form data with username, password and grant_type properties):		Body (form data with username, password and grant_type properties):
Line 11:		Line 11:
	When using SAML 2.0 authentication, instead of the password, the url needs to have a ''samlhash'' parameter (value for it has been received earlier using [[Web_API:_Samlsignin\|/api/samlsignin]]):		When using SAML 2.0 authentication, instead of the password, the url needs to have a ''samlhash'' parameter (value for it has been received earlier using [[Web_API:_Samlsignin\|/api/samlsignin]]):
	<pre>		<pre>
	Url: POST /token?samlHash=<samlhash>		Url: POST qprpa/api/token?samlHash=<samlhash>
	</pre>		</pre>

Ollvihe at 09:59, 16 February 2022

2022-02-16T09:59:26Z

← Older revision		Revision as of 09:59, 16 February 2022
Line 3:		Line 3:
	The token request is following:		The token request is following:
	<pre>		<pre>
	Url: POST /token		Url: POST api/token
	Content-Type: application/x-www-form-urlencoded		Content-Type: application/x-www-form-urlencoded
	Body (form data with username, password and grant_type properties):		Body (form data with username, password and grant_type properties):

Ollvihe at 19:29, 11 December 2021

2021-12-11T19:29:43Z

← Older revision		Revision as of 19:29, 11 December 2021
Line 23:		Line 23:
	The response contains the following fields:		The response contains the following fields:
	* '''access_token''': contains the access token (session id).		* '''access_token''': contains the access token (session id).
	* '''globalPermissions''': [[~~Roles_and_Permissions_in_QPR_ProcessAnalyzer~~#Mapping_Roles_and_Permissions\|Global permissions]] of the user as comma separated list.		* '''globalPermissions''': [[Roles_and_Permissions#Mapping_Roles_and_Permissions\|Global permissions]] of the user as comma separated list.
	* '''serverVersion''': Version of the QPR ProcessAnalyzer server.		* '''serverVersion''': Version of the QPR ProcessAnalyzer server.
	* '''token_type''': contains always "bearer"		* '''token_type''': contains always "bearer"

Ollvihe at 08:42, 6 October 2021

2021-10-06T08:42:37Z

← Older revision		Revision as of 08:42, 6 October 2021
Line 14:		Line 14:
	</pre>		</pre>

	Note that the path doesn't contain ''api'', unlike other operations in the Web API. Example url: <nowiki>https://customer.onqpr.com/qprpa/token</nowiki>		Note that the path doesn't contain ''api'', unlike other operations in the Web API. Example url: <nowiki>https://customer.onqpr.com/qprpa/token</nowiki>.

	Request body contains the following parameters as url encoded:		Request body contains the following parameters as url encoded:

Ollvihe at 08:42, 6 October 2021

2021-10-06T08:42:28Z

← Older revision		Revision as of 08:42, 6 October 2021
Line 14:		Line 14:
	</pre>		</pre>

	Note that the path doesn't contain ''api'', unlike other operations in the Web API. Example url:		Note that the path doesn't contain ''api'', unlike other operations in the Web API. Example url: <nowiki>https://customer.onqpr.com/qprpa/token</nowiki>
	<~~pre~~>
	https://customer.onqpr.com/qprpa/token
	</~~pre~~>

	Request body contains the following parameters as url encoded:		Request body contains the following parameters as url encoded: