hosting

POST /v1/sites/{siteId}/application-access/sign-in

One-click sign-in to the application installed on a site.

All hosting endpoints

All developer docs →

Zinn®, our Viking, hammering at his anvil beside an API endpoint sending events to several listeners.

Authentication

Send an API key as a bearer token. The key must carry the sites.view permission; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/application-access/sign-in \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Mints a single-use, ~2-minute sign-in link for the site's application administrator (AbanteCart, Concrete CMS, Craft, Dolibarr, Drupal, Joomla, Matomo, Mautic, MediaWiki, MODX, Moodle, Nextcloud, OpenCart, osTicket, ownCloud, Payload, phpBB, Piwigo, PrestaShop, Silverstripe, Strapi, SuiteCRM, TYPO3 and Zenphoto; can_sign_in on getSiteApplicationAccess says which, and docs/139 §6a says why the others have none). The token is signed with a key derived for this site alone and is checked, spent and exchanged for the application's own session by zinn-login.php on the site (docs/139 §"One-click sign-in"). For a Node application (Strapi, Payload) the URL is https://<domain>/zinn-login#t=<token>: the token is in the fragment, which the browser never sends to a server, and the page at /zinn-login posts it. A Node site deployed before that page existed has its managed startup file brought up to date and its application restarted by this call (only when the file changed; never by the hourly converge), so the first click on such a site can take a little longer. Before minting, the platform makes sure that file and the site's key are on the server (idempotent). Requires sites.view and sites.panel_access in the site's organisation, like the password reveal. Each link is audit-logged as site.application_sign_in with the real actor, before it is returned. Refusals carry a code in details[].code (field site): APP_SSO_UNSUPPORTED (409, no sign-in for this application), SITE_NOT_SERVING (409), PLATFORM_CANNOT_SSO (422, the hosting platform has no shell), REPAIR_FAILED (503, the sign-in could not be prepared on the server); none of them writes an audit row.

Parameters

NameTypeRequiredWhat it is
siteId (path)UuidYesSite ID (UUIDv7).

Response

NameTypeRequiredWhat it is
urlstringYeshttps://<domain>/zinn-login.php?t=<token> for a PHP application; https://<domain>/zinn-login#t=<token> (fragment) for Strapi and Payload.
expires_atstringYes—

Errors this endpoint can return

401 · 403 · 404 · 409 · 422 · 429 · 503