API SSO - Revision history

Trent: Remove username/password API auth; ApiKey only

2026-07-25T18:55:18Z

Remove username/password API auth; ApiKey only

Trent: Document SSO URL generation

2026-07-25T18:49:49Z

Document SSO URL generation

Peter at 03:57, 11 April 2024

2024-04-11T03:57:45Z

Michael at 21:03, 3 November 2021

2021-11-03T21:03:09Z

Trent: Created page with "== SSO == You can use our api to get a SSO url that will allow you to sign-in a user when they go to that url. This token is only good for one time and expires in just a few m..."

2021-02-16T16:31:23Z

Created page with "== SSO == You can use our api to get a SSO url that will allow you to sign-in a user when they go to that url. This token is only good for one time and expires in just a few m..."

New page

== SSO ==
You can use our api to get a SSO url that will allow you to sign-in a user when they go to that url. This token is only good for one time and expires in just a few minutes. You should only create this token when the user has requested to sso into your zFairs site. If you want to get an SSO URL you need to POST a message to your site. Below is an example of what needs to be posted.

<syntaxhighlight lang="JavaScript" line>

fetch('/api/data/sso', {
method:'POST',
headers:{'Content-Type': 'application/json'},
body: JSON.stringify({
Username:'admin username',
Password: 'password',
FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', //This value can be found in your url it's the value of f
Body: {
PersonId:'persons id (36 char GUID)' //Required
}
})
})
.then(response => response.json())
.then(data=>{console.log('Success: ',data);})
.catch((error)=>{console.log('Error: ', error);});

</syntaxhighlight>

== Where to get values ==
You will get the person when you use our API to add the person or project. Do not use the project key.

@@ Line 9: / Line 9: @@
 ! Field !! Required !! Description
 |-
-| <code>ApiKey</code> || Yes* || Private API key for your site. Prefer this over username/password.
+| <code>ApiKey</code> || Yes || Private API key for your site.
 |-
 | <code>FairId</code> || Yes || Fair GUID from the site URL (<code>f</code> query parameter).
@@ Line 18: / Line 16: @@
 |}
 Calls must be run '''server-side''' — do not expose your API key in a browser.

@@ Line 1: / Line 1: @@
 == SSO ==
-You can use our api to get a SSO url that will allow you to sign-in a user when they go to that url. This token is only good for one time and expires in just a few minutes. You should only create this token when the user has requested to sso into your zFairs site. If you want to get an SSO URL you need to POST a message to your site. Below is an example of what needs to be posted.
+Builds a one-time single sign-on URL for an existing person so they can land in the fair already logged in.
- fetch('/api/data/sso', {
+=== Authentication ===
- 	method:'POST',
+All data API calls are <code>POST</code> (unless noted) with JSON body:
-== Where to get values ==
+{| class="wikitable"
-You will get the person when you use our API to add the person or project. Do not use the project key.
+|-
-<br/><br/><br/><br/>
+=== Response envelope ===
 [[Category: API]]

@@ Line 6: / Line 6: @@
   	headers:{'Content-Type': 'application/json'},
   	body: JSON.stringify({
-  		Username:'admin username',
+  		ApiKey:'<Private key>',
   		FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', //This value can be found in your url it's the value of f
   		Body: {