v1

latestOpenAPI 3.0.3Apache 2.02026-07-17341573.2 KB

Setup Links | Directory Sync

Create a Setup Link

post/api/v1/dsync/setuplinks

Request body

namestring

Name of connection

tenantstring required

Tenant

productstring required

Product

webhook_urlstring required

The URL to send the directory sync events to

webhook_secretstring required

The secret to sign the directory sync events

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