Primo API Docs

__METHOD= POST . __PATH= /primo/v1/userJwt .

user JWT creater

This service returns a user JWT indicator, which is used to manage the session, and used to get the User's information (such as a list of favorite records from Primo or enable access to restricted data).
TNote: For security considerations, this API is available to Primo/Primo VE cloud customers only.

For example, the JWT will appear as follows when added to the header in the API request:
key=Authorization, value = Bearer "eyJraWQiOiJwcmltb0V4cGxvcmVQcml2YXRlS2V5LTAxQkNfSU5TVCIsImFsZyI6IkVTMjU2In0.eyJpc3MiOiJQcmltbyIsImp0aSI6IiIsImV4cCI6MTUxMjk5MDAyOSwiaWF0IjoxNTEyOTAzNjI5LCJ1c2VyIjoiYW5vbnltb3VzLTEyMTBfMTEwMDI5IiwidXNlck5hbWUiOm51bGwsInVzZXJHcm91cCI6IkdVRVNUIiwiYm9yR3JvdXBJZCI6bnVsbCwidWJpZCI6bnVsbCwiaW5zdGl0dXRpb24iOiIwMUJDX0lOU1QiLCJ2aWV3SW5zdGl0dXRpb25Db2RlIjoiMDFCQ19JTlNUIiwiaXAiOiIxMC4xLjExNi4yMzQiLCJvbkNhbXB1cyI6ImZhbHNlIiwibGFuZ3VhZ2UiOiJlbl9VUyIsImF1dGhlbnRpY2F0aW9uUHJvZmlsZSI6IiIsInZpZXdJZCI6IkJDX1ZJRVciLCJpbHNBcGlJZCI6bnVsbCwic2FtbFNlc3Npb25JbmRleCI6IiJ9.6IdBSkWQfgV79Vx9nOeBQCcO4W9-_pxEOPiQDvHn3aJVKQ-uDIkI1O5ZLo2xdFtlRW0UxINqh5bJ2yjUCX0zGg"

This POST request should have a payload of the user details, which should be added to the request body
The payload should be written in JSON format and should include the following fields:

For Primo:
viewId : The view. Example: Auto1
institution: The institution. The default value is the default institution of the view. Example: VOLCANO.
language: The language. The default value is the default language from the view. Example: en_US.
user: The user ID
userName: The displayed name
userGroup: Name of user group
onCampus: Indicates whether the user has permission to view 'on campus' data. The default value is false.

For Primo VE:
viewId : The view. Example: Auto1
institution: The institution. The default value is the default institution of the view. Example: VOLCANO.
language: The language. The default value is the default language from the view. Example: en_US.
userName:The user ID
userGroup: Name of user group
onCampus: Indicates whether the user has permission to view 'on campus' data. The default value is false.



Note: The details should be sent after the authentication process, and it must not be sent from the browser.


Basic URL example for hosted Primo customers:
<api-gateway-url>/primo/v1/userJwt/
Payload example:
{
"viewId": "Auto1"
"institution": "VOLCANO",
"language": "",
"user": "enduser",
"userName": "Francis, Bacon",
"userGroup": "group_a",
"onCampus": "false",
}

Resource URL

POST /primo/v1/userJwt

API Description

URL Parameters

None

Querystring Parameters

None

Body Parameters

None

Output

Possible Error Codes

CodeMessage