v1

latestOpenAPI 3.0.3Apache 2.02026-07-17341573.2 KB

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
  }
]