Sign in
Setup Links | Single Sign On

Create a Setup Link

post/api/v1/sso/setuplinks

Request body

namestring

Name of connection

tenantstring required

Tenant

productstring required

Product

defaultRedirectUrlstring required

The redirect URL to use in the IdP login flow

redirectUrlstring required

JSON encoded array containing a list of allowed redirect URLs

expiryDaysnumber

Days in number for the setup link to expire

regenerateboolean

If passed as true, it will remove the existing setup link and create a new one.

Response

Success

setupIDstring

Setup link ID

tenantstring

Tenant

productstring

Product

validTillstring

Valid till timestamp

urlstring

Setup link URL

Example response

{
  "data": {
    "setupID": "0689f76f7b5aa22f00381a124cb4b153fc1a8c08",
    "tenant": "acme",
    "product": "my-app",
    "service": "sso",
    "validTill": 1689849146690,
    "url": "http://localhost:5225/setup/0b96a483ebfe0af0b561dda35a96647074d944631ff9e070"
  }
}

Changes

Changed in 3 of the 50 revisions of this API.41

  • beea10f3e7fb1See the full diff
    • ▲

      removed the media type application/x-www-form-urlencoded from the request body

      request-body-media-type-removed

  • f02a45abeffc11See the full diff
    • ▲

      added required request body

      request-body-added-required

    • ○

      added the media type application/json for the response with the status 200

      response-media-type-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • d49c203898c22See the full diff
    • ▲

      removed the request body

      request-body-removed

    • ▲

      removed the media type application/json for the response with the status 200

      response-media-type-removed

    This revision also has 16 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog