Skip to content

Get SSO Token and Host ID from Postman

Sara edited this page Aug 1, 2024 · 3 revisions

Login Instructions

To log in to the application, you'll need the following details:

  • Domain Input
  • SSO Token
  • Host ID
  • Access Code

Note: This document guides you through acquiring the SSO token and Host ID using Postman.

The documentation will utilize environment variables to retrieve data.

Starting with Creating an Environment:

  1. Setting up Postman:
    • Download and open Postman.
    • From the left sidebar, select Environment and create a new environment.

Getting the Authentication Token:

  1. Setting up Collection:
    • From the left sidebar, select Collections.
    • Create a new collection.
    • Initiate a new request within this collection.
    • On the top right, choose to use the environment just created:

image

  1. Setting the Request Type and URL:

    • Choose POST as the request type.
    • In the URL input field, type in the base URL of your website followed by /enterprise_api/authenticate.

      Example: If the website is https://iotum.callbridge.rocks, then your input would be: https://iotum.callbridge.rocks/enterprise_api/authenticate

  2. Adding Query Parameters:

    • In the Query Params section, create one key: api_token
      • "API Tokens" can be managed in the "Developers" section of the Admin UI, accessible by reseller admins or company admins.
    • Input your account information corresponding to these keys:
image
  1. Fetching the auth token:

    • Click Send.
    • Once the request is processed, you will receive your auth_token in the body of the response.
  2. Create a Variable for the Token:

    • Click Pre-request Script.
    • Insert pm.environment.set("variable_key", "variable_value"); in the script.

      Example: If you want to name your auth_token as TOKEN, then your input would be pm.environment.set("auth_token", "TOKEN");

    • Go back to Environment, and create a new Variable. Name it as TOKEN, in the current value, copy the auth_token value:

    image

    • Now you can refer your auth_token as {{TOKEN}}

Getting the Company ID:

  1. Setting the Request Type and URL:

    • Initiate a new request within the same collection.
    • Choose POST as the request type.
    • In the URL input field, type in the base URL of your website followed by /enterprise_api/company/fetch_all.

      Example: If the website is https://iotum.callbridge.rocks, then your input would be: https://iotum.callbridge.rocks/enterprise_api/company/fetch_all

  2. Adding Query Parameters:

    • In the Query Params section, create a key named: auth_token.
    • Input {{TOKEN}}: image
  3. Fetching the Company ID:

    • Click Send.
    • Once the request is processed, you will find your company_id in the body of the response.
    • Save this ID for future reference.

Getting the HOST ID:

  1. Setting the Request Type and URL:

    • Initiate a new request within the same collection.
    • Choose POST as the request type.
    • In the URL input field, type in the base URL of your website followed by /enterprise_api/host/fetch_all

      Example: If the website is https://iotum.callbridge.rocks, then your input would be: https://iotum.callbridge.rocks/enterprise_api/host/fetch_all

  2. Adding Query Parameters:

    • In the Query Params section, create two keys: auth_token and company_id.
    • Input {{TOKEN}} and the company_id value you acquired in the previous steps: image
  3. Fetching the Host ID:

    • Click Send.
    • Once the request is processed, you will find your host_id in the body of the response.
    • Save this ID for future reference.

Getting the SSO Token:

  1. Setting the Request Type and URL:

    • Initiate a new request within the same collection.
    • Choose POST as the request type.
    • In the URL input field, type in the base URL of your website followed by /enterprise_api/host/fetch

      Example: If the website is https://iotum.callbridge.rocks, then your input would be: https://iotum.callbridge.rocks/enterprise_api/host/fetch

  2. Adding Query Parameters:

    • In the Query Params section, create two keys: auth_token and host_id.
    • Input {{TOKEN}} and the host_id value you acquired in the previous steps: image
  3. Fetching the SSO Token:

    • Click Send.
    • Once the request is processed, you will find your login_token_public_key in the body of the response.
    • Save this ID for future reference, this is the SSO token.

Login to the Application:

  1. Choosing the Domain:

    • Select your desired domain.
  2. Entering SSO Token and Host ID:

    • Input your SSO token and host ID.
    • Click on Submit to proceed.
  3. Entering the Access Code:

    • Provide your access code. This is essentially your conference number which can be located in the Meet dashboard.
  4. Using the Application:

    • After logging in, you can now utilize and explore the features of the iotum product. Enjoy!