All pages
Powered by GitBook
1 of 9

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Okta SSO

In this section you will learn about Okta SSO

1. Go to SSO Applications

2. Create a new SSO application

3. Go to Okta applications and create new SAML Service Provider

4. Specify Attributes Statements

5. Scroll down and open View Setup Instructions to copy Identity Provider Issuer and enter it below

6. Download Identity Provider metadata

7. Edit metadata and add entityID attribute (Identity Provider Issuer)

8. Add User assignments

9. Upload metadata and set ACS url in Okta

10. You are all set

SSO button should appear automatically on the login and register pages when visiting Jet Admin from your custom domain.

Sign In/Sign Up

In this section you will learn how to build Sign In/Sign Up Page

You don't need to build the Sign-in/Sign-up page in the UI, as Jet already has a separate Sign-in/Sign-up page builder.

To access it,

  1. Click on the Sign-in & Sign-up icon inside the builder

Sign-in/Sign-up page

Sign-in/Sign-up page has three major sections:

  • (1) Menu - configure the appearance, sign-in, and sign-up separately

  • (2) The preview - check in real-time changes taking effect

  • (3) Setting - this is where the configuring happens

To be able to customize the Sign-in/Sign-up, you need to set up a custom domain first. See the image below.

Learn how to set up a custom domain in the following article:

Appearance

The appearance tab allows you to:

  • (1) Switch between the layouts

  • (2) Set the background picture

  • (3) Set the color theme

Sign-in & Sign-up

The sign-in and sign-up tabs allow you to configure the settings, specific to the sign-in and sign-up, such as Terms of service URL, titles, and customer sign-up flow for the Portal.

Auth0 SSO OAuth 2.0

In this section you will learn about Auth0 SSO OAuth 2.0

1. Go to SSO Applications

2. Create a new SSO application

API calls with SSO token

In this section you will learn about API calls with SSO token

Authorizing API calls to your backend with SSO token

When user is logged in with SSO it is possible to use SSO access token in HTTP queries (Rest API or GraphQL). Such requests are going through api.jetadmin.io endpoint or self-hosted Jet Bridge (when set up as ).

You can insert any SSO tokens in HTTP/GraphQL queries using SSO credentials section.

(4) Enable the White label
Custom domain

3. Go to Auth0 applications and create a new Application

4. Copy credentials to Jet Admin

Choose Provider Auth0OAuth2 on Jet Admin and then copy Domain, Client ID, Client Secret from Auth0. You should also set Scope as openid,profile,email,offline_access.

5. Set Allowed Callback URL on Auth0

Copy the REDIRECT URL from Jet Admin in the Application parameters section to Auth0 Allowed Callback URLs and click Save on both - Auth0 and Jet Admin.

6. You are all set

SSO button should appear automatically on the login and register pages when visiting Jet Admin from your custom domain.

HTTP proxy

Auth0 SSO SAML2

In this section you will learn about Auth0 SSO SAML2

1. Go to SSO Applications

2. Create a new SSO application

3. Go to Auth0 applications and create new Application

4. Activate SAML2 Web App

5. Specify mappings in Settings

6. Download metadata

7. Upload metadata and set ACS url in Auth0

8. You are all set

SSO button should appear automatically on the login and register pages when visiting Jet Admin from your custom domain.

{
  "mappings": {
    "email": "Email",
    "given_name": "FirstName",
    "family_name": "LastName"
  }
}

Google SSO OAuth 2.0

Step-by-step guide to authentication with Google OAuth 2.0

If you want to use Google services such as Google Sheets, Google Drive, Google Cloud and many others, this step-by-step guide can help you with Google OAuth 2.0 authentication.

Once you have created the project and selected the Rest API resource, you also selected the OAuth 2.0 authentication method - you need to select a provider.

Google Developers Console

1. Google API Console

Visit the to obtain OAuth 2.0 credentials such as a Client ID and Client secret that are known to both Google and Jet Admin.

2. Create a new project

3. Specify new project details

Specify Project name and Location then click the Create button.

4. Enable APIs and Services

In the control panel, enable the API and Services you plan to use.

The API library looks like this. You can choose any service you are plan to use, but we will go through the Google Sheet API.

Once you have selected the API and services, click the Enable button.

5. Create Credentials

To use this API, you need credentials. Go to the credentials menu to get started.

Сonfigure the OAuth consent screen:

Choose how you want to configure and register your app, including your target users. You can only associate one app with your project. Then click Create.

Specify the application name, scroll down the page, and click Save.

Go to the credentials menu and click Create credentials. Then select OAuth Client ID.

Then you need to select the application type. In the drop-down list, select Web application. Specify name, you also can add OAuth Redirect URL, then click Create. https://api-dev.jetadmin.io/api/create_oauth_token_complete/

Congratulations, your client ID and client secret created.

5. Adding resource

To complete the process of adding a resource, we need to fill in the scopes field.

You can find the necessary information . For our case, the scopes look like this.

Conclusion

Congratulations! Now you are ready to authenticate with Google OAuth 2.0. If you still have any questions, please contact us for help.

Google SSO SAML2

In this section you will learn about Google SSO SAML2

Setting up SSO for your Jet Admin project requires your to set up Custom Domain for your project first.

1. Go to SSO Applications

2. Create a new SSO application

3. Open your G Suite SAML Apps and create a new one

G Suite Apps page is located at

4. Select SETUP MY OWN CUSTOM APP

5. Download IDP metadata .xml file

6. Specify application basic information

7. Set up Jet Admin SSO application and copy ACS URL

Specify Entity ID and upload saved Metadata (.xml) file from the previous step. Entity ID should be unique text identifier of your application

ACS URL displayed at the bottom of page will be needed on the next step.

8. Set up G Suite SAML App

Specify ACS URL and Entity ID entered on the previous step

9. Set attributes mapping

You should specify 3 attributes to map on Jet Admin user account:

  • Email should map to Basic Information - Primary Email

  • FirstName should map to Basic Information - First Name

  • LastName should map to Basic Information - Last Name

10. You are all set

SSO button should appear automatically on the login and register pages when visiting Jet Admin from your custom domain.

Scopes

Description

https://www.googleapis.com/auth/spreadsheets

See, edit, create, and delete your spreadsheets in Google Drive

https://www.googleapis.com/auth/spreadsheets.readonly

View your Google Spreadsheets

Google API Console
here
https://admin.google.com/u/1/ac/apps

Custom SSO OAuth 2.0

In this section you will learn about Custom SSO OAuth 2.0

Apart from a number of pre-built SSO providers we support integrating with fully Custom OAuth 2.0 compatible providers.

The process is not automatic:

  • First you need to implement OAuth2 flow on your side and make sure it works. You should implement three types of requests for it listed below.

  • Any SSO integrations require you to connect your custom domain.

  • Contact our tech engineers to test and finish integration on our side. OAuth implementation can vary from provider to provider so we implemented ability to customize OAuth requests used in integration (HTTP method, JSON/Form data, Scope separator, etc.). Our engineers will adapt to your implementation during integration process, but we recommend to stick to the most popular industry implementations (preferable to use open source implementations for your tech stack).

These are global parameters generated on your side

  • CLIENT_ID - You apps client id used to identify Jet Admin requests (passed public)

  • CLIENT_SECRET - You apps client secret used by Jet Admin to perform requests (stored internally)

  • SCOPE - (optional) If your backend requires access_token to have list of scopes to make queries this parameter will be used to obtain access_token

1. Authorization URL

Initial page which user is redirected to on Sign In page

GET https://YOUR_SSO_DOMAIN/authorize

Query Parameters

Name
Type
Description

If you have only 1 sign in method (SSO) user will be automatically redirected to your SSO initial page without seeing Jet Admin.

After Sign In process user will be redirected back to Jet Admin side.

Page that processes received "code" and performs step 2.

GET https://api.jetadmin.io/complete/custom_oauth_2/

Query Parameters

Name
Type
Description

2. Access token URL

The method is called by Jet Admin backend to get "access" and "refresh" tokens

POST https://YOUR_SSO_DOMAIN/token

Request Body

Name
Type
Description

access_token JWT payload should have fields:

  • first_name

  • last_name (optional)

  • username (can be equal to email)

  • email

access token and refresh token obtained on this step are saved on api.jetadmin.io side.

(optional) If you have self-hosted Jet Bridge set up as access token and refresh token can be saved on self-hosted Jet Bridge side.

3. Refresh token URL

Can be the same as Access token URL, but with different data

The method is called by Jet Admin backend to refresh expired "access token"

POST https://YOUR_SSO_DOMAIN/token

Request Body

Name
Type
Description

Authorizing API calls to your backend with SSO token

scope*

String

ex. "openid profile offline_access" Depends on your implementation, should be minimal scope needed to get user profile (first name, last name, email)

authuser

String

0

redirect_uri*

String

https://api.jetadmin.io/complete/custom_oauth_2/

client_id*

String

CLIENT_ID

state*

String

Special OAuth2 generated code, created on Jet Admin side

redirect_uri*

String

ex. https://api.jetadmin.io/complete/custom_oauth_2/ Should be as specified here, you can validate it on your side (optionally)

response_type*

String

code

state*

String

Special OAuth2 generated code, created on Jet Admin side

code*

String

Special OAuth2 generated code, created on Custom provider side

scope*

String

Previously received scope

prompt*

String

consent

grant_type*

String

authorization_code

code*

String

Special OAuth2 generated code, created on Custom provider side

client_id

String

CLIENT_ID

client_secret*

String

CLIENT_SECRET

grant_type*

String

refresh_token

refresh_token*

String

client_id

String

CLIENT_ID

client_secret*

String

CLIENT_SECRET

HTTP proxy
API calls with SSO token
{
    'token_type': 'Bearer',
    'access_token': 'ya29.A0ARrdaM9Hc_Hz__EhytWaIlHcYGkaszuxgKVqeEWBfErtEbHOPRF2_YtvlSY5qbkW2ZKbvbCNPtxGJJHutBsWd2hfmE8ZCdRX0bpQw5iwDfTBJZjQ7S9kKRiiCR165DyLs8hnERkjd3Z8-1-hPSt1X9MrY8aX',
    'expires_in': 3599, 
    'refresh_token': '1//09uFin2WWZE9gCgYIARAAGAkSNwF-L9Irrrh5VtbNA35jfyWv8xnrj-VSqMKwCP-yjKtP6h6IDA6A0-S-LgqGve9Z-RLZzFdZpaE',
    'scope': 'openid profile offline_access'
}
{
    'token_type': 'Bearer',
    'access_token': 'ya29.A0ARrdaM9Hc_Hz__EhytWaIlHcYGkaszuxgKVqeEWBfErtEbHOPRF2_YtvlSY5qbkW2ZKbvbCNPtxGJJHutBsWd2hfmE8ZCdRX0bpQw5iwDfTBJZjQ7S9kKRiiCR165DyLs8hnERkjd3Z8-1-hPSt1X9MrY8aX',
    'expires_in': 3599, 
    'refresh_token': '1//09uFin2WWZE9gCgYIARAAGAkSNwF-L9Irrrh5VtbNA35jfyWv8xnrj-VSqMKwCP-yjKtP6h6IDA6A0-S-LgqGve9Z-RLZzFdZpaE', 
    'scope': 'openid profile offline_access'
}

Azure AD SSO OAuth 2.0

In this section you will learn about Azure AD SSO OAuth 2.0

1. Go to Sign In & Sign Up -> Authentication

2. Create a new External SSO

Specify Name and New members team for newly created External SSO

3. Go to Azure Active Directory -> App registrations and create new new Application

In Redirect URI (optional) section fill the following fields

  • Platform: Web

  • URL: copy REDIRECT URL from Jet Admin -> External SSO -> Application parameters section.

4. Copy credentials to Jet Admin

  • Copy Application (client) ID and Directory (tenant) ID from App Registration page in Azure portal to Jet Admin External SSO

  • Then open Certificates & secrets page, create new Client secret and copy it's Value to Jet Admin Client Secret

  • You should also set Scope to openid,profile,email,offline_access

5. You are all set

SSO button should appear automatically on the login and register pages when visiting Jet Admin from your custom domain.

.