Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-17341573.2 KB
Single Sign-On

Create SSO connection

post/api/v1/sso

Request body

namestring

Name of connection

labelstring

An internal label to identify the connection

descriptionstring

A short description for the connection not more than 100 characters

encodedRawMetadatastring

Base64 encoding of the XML metadata

rawMetadatastring

Raw XML metadata

metadataUrlstring

URL containing raw XML metadata

defaultRedirectUrlstring required

The redirect URL to use in the IdP login flow

redirectUrlstring[] required

JSON encoded array containing a list of allowed redirect URLs

tenantstring required

Tenant

productstring required

Product

oidcDiscoveryUrlstring

well-known URL where the OpenID Provider configuration is exposed

oidcMetadatastring

metadata (JSON) for the OpenID Provider in the absence of discoveryUrl

oidcClientIdstring

clientId of the application set up on the OpenID Provider

oidcClientSecretstring

clientSecret of the application set up on the OpenID Provider

sortOrdernumber

Indicate the position of the connection in the IdP selection screen

acsUrlOverridestring

Override the global ACS URL on a per connection basis

samlAudienceOverridestring

Override the global SAML Audience on a per connection basis

forceAuthnboolean

Require a new authentication instead of reusing an existing session.

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
}