Single Sign-On

Get SSO Connections by product

get/api/v1/sso/product

Query parameters

productstring required

Product

pageOffsetstring

Starting point from which the set of records are retrieved

pageLimitstring

Number of records to be fetched for the page

pageTokenstring

Token used for DynamoDB pagination

Response

Success

clientIDstring

Connection clientID

clientSecretstring

Connection clientSecret

namestring

Connection name

labelstring

Connection label

descriptionstring

Connection description

redirectUrlstring[]

A list of allowed redirect URLs

defaultRedirectUrlstring

The redirect URL to use in the IdP login flow

tenantstring

Connection tenant

productstring

Connection product

idpMetadataobject

SAML IdP metadata

oidcProviderobject

OIDC IdP metadata

deactivatedboolean

Connection status

sortOrdernumber

Connection sort order

acsUrlOverridestring

Override the global ACS URL on a per connection basis

samlAudienceOverridestring

Override the global SAML Audience on a per connection basis

Example response

[
  {
    "idpMetadata": {
      "sso": {
        "postUrl": "https://dev-20901260.okta.com/app/dev-20901260_jacksonnext_1/xxxxxxxxxxxsso/saml",
        "redirectUrl": "https://dev-20901260.okta.com/app/dev-20901260_jacksonnext_1/xxxxxxxxxxxsso/saml"
      },
      "entityID": "http://www.okta.com/xxxxxxxxxxxxx",
      "thumbprint": "Eo+eUi3UM3XIMkFFtdVK3yJ5vO9f7YZdasdasdad",
      "loginType": "idp",
      "provider": "okta.com"
    },
    "defaultRedirectUrl": "http://localhost:3000/default",
    "redirectUrl": [
      "http://localhost:3000/default"
    ],
    "tenant": "example.com",
    "product": "API Engine",
    "name": "Hoppscotch-SP",
    "description": "SP for example.com",
    "clientID": "Xq8AJt3yYAxmXizsCWmUBDRiVP1iTC8Y/otnvFIMitk",
    "clientSecret": "00e3e11a3426f97d8000000738300009130cd45419c5943",
    "deactivated": false
  }
]

Changes

Changed in 4 of the 50 revisions of this API.224

Mar 19, 202549165dcc099e1See the full diff
- ○
  added the optional property / to the response with the status
  response-optional-property-added
Mar 5, 20256391a568431c1See the full diff
- ○
  added the optional property / to the response with the status
  response-optional-property-added
Feb 5, 2025f02a45abeffc12See the full diff
- ▲
  the response's body type changed from object to array for status
  response-body-type-changed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 22, 2024d49c203898c212See the full diff
- ▲
  the response's body type changed from array to object for status
  response-body-type-changed
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
This revision also has 16 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history