ETethiack
organizations

Set up federated login from your own IdP (owner)

Mint the owner's own IdP template in one call -- no admin, no slug to pick.

The self-service counterpart to the admin's two-step (PUT .../sso/template then POST .../sso/idp): :meth:OwnerSsoProvisioningWorkflow.establish derives the slug from the organization name, creates the connection disabled and unverified, and mints the template. SSO is a paid feature, so an organization whose plan lacks it is refused (402) before any Zitadel call. First-time setup only -- an organization already pointed at a template is refused (409); changing a live one is PUT .../sso/idp/self.

For SAML the response is part of the deliverable -- the ACS, metadata, certificate and SLO URLs unique to this template, which the customer configures their IdP against.

Args: organization_id (int): The parent organization. payload (SsoIdpRequest): Provider configuration, discriminated on protocol. db (AsyncSession): Request-scoped session. context (ActiveContext): Resolved caller.

Returns: IdpTemplateResponse: The template id and, for SAML, the customer's URLs.

post/v1/organizations/{organization_id}/sso/idp/self

Request

  • Base URL
    https://api.ethiack.com (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Path parameters

organization_idinteger required

Request body

OR

Response

Successful Response

zitadel_idp_idstring required

The Zitadel IdP template this organization's federated logins now run against.

protocol'oidc' | 'saml' required

Which protocol family the template configures.

acs_urlstring nullable

SAML only. The Assertion Consumer Service URL the customer must configure in their IdP. Unique to this template, which is what keeps one customer's assertions off another's connection.

sp_metadata_urlstring nullable

SAML only. Zitadel's SP metadata for this template, for customers who prefer importing it over manual entry. Named for the direction: the request bodies' metadata_url is the opposite one, the customer's IdP metadata that Zitadel fetches.

certificate_urlstring nullable

SAML only. Zitadel's signing certificate for this template.

slo_urlstring nullable

SAML only. Single-logout endpoint for this template.

Changes

No recorded changes to this operation across all 1 revision of this API.