SCscalekit
Organizations

Generate admin portal link

Creates a single use Admin Portal URL valid for 1 minute. Once the generated admin portal URL is accessed or rendered, a temporary session of 6 hours is created to allow the admin to update SSO/SCIM configuration.

put/api/v1/organizations/{id}/portal_links

Request

Path parameters

idstring required

Organization ID

Query parameters

featuresstring[]

Features to enable in the admin portal link. To enable features, append them as URL parameters:

  • Single Sign-On: ?features=sso
  • Directory Sync: ?features=dir_sync
  • Both features: ?features=sso&features=dir_sync

Example URL: https://example.com/portal/lnk_{id}?features=sso

  • dir_sync: Enables directory synchronization configuration in the portal
  • sso: Enables Single Sign-On (SSO) configuration in the portal

Response

Admin Portal link generated successfully. Returns the portal URL and expiration timestamp.

Example response

{
  "link": {
    "expire_time": "2024-02-06T14:48:00Z",
    "id": "lnk_123123123123123",
    "location": "https://example.com/portal/lnk_{id}"
  }
}

Changes

No recorded changes to this operation across all 16 revisions of this API.