ORory
Setup Links | Single Sign On

Create a Setup Link

Changed on
post/api/v1/sso/setuplinks

Request

  • Base URL
    http://localhost:5225
  • URL
    http://localhost:5225/api/v1/sso/setuplinks
  • Auth
    API key in header Authorization

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