Generated by API Evangelist
Written by API Evangelist tooling for ControlUp's API. It is a proposal applied on top of the contract, not a document ControlUp publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Dex SAML API
version: 1.0.0
extends: openapi/controlup-saml-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 4
- target: $.paths['/organizations/{orgId}/saml'].get
update:
x-apievangelist-phrasing:
intent: Get the SAML SSO configuration
effect: read
questions:
- What SAML settings are currently saved for my organization?
- Which IdP and default role is my SAML SSO using?
instructions:
- text: Show the SAML configuration for organization {orgId}.
slots:
orgId: path.orgId
- text: Get the current SAML SSO settings of org {orgId}.
slots:
orgId: path.orgId
method: generated
generated: '2026-09-26'
- target: $.paths['/organizations/{orgId}/saml'].post
update:
x-apievangelist-phrasing:
intent: Set up SAML SSO, overwriting any existing
effect: write
questions:
- Can I configure SAML SSO from scratch with my IdP's certificate and SSO URL?
- Does creating SAML settings overwrite the existing configuration?
instructions:
- text: Configure SAML for org {orgId} with SSO URL {ssoServiceUrl}, certificate {certificate}, IdP {idpPartnerName}, URN {urn} and default role {defaultRoleId}.
slots:
orgId: path.orgId
ssoServiceUrl: requestBody.ssoServiceUrl
certificate: requestBody.certificate
idpPartnerName: requestBody.idpPartnerName
urn: requestBody.urn
defaultRoleId: requestBody.defaultRoleId
- text: Replace org {orgId}'s whole SAML setup using IdP {idpPartnerName}.
slots:
orgId: path.orgId
idpPartnerName: requestBody.idpPartnerName
method: generated
generated: '2026-09-26'
- target: $.paths['/organizations/{orgId}/saml'].patch
update:
x-apievangelist-phrasing:
intent: Update specific SAML settings
effect: write
questions:
- Can I rotate just the SAML signing certificate?
- Can I change only the default role for SAML users?
instructions:
- text: Update the SAML certificate for org {orgId} to {certificate}.
slots:
orgId: path.orgId
certificate: requestBody.certificate
- text: Change the SAML default role of org {orgId} to {defaultRoleId}.
slots:
orgId: path.orgId
defaultRoleId: requestBody.defaultRoleId
method: generated
generated: '2026-09-26'
- target: $.paths['/organizations/{orgId}/saml/{idpName}'].post
update:
x-apievangelist-phrasing:
intent: Auto-configure SAML from an IdP integration
effect: write
questions:
- Can SAML SSO be set up automatically from my Entra ID integration?
- Is there a shortcut so I don't have to enter SAML settings by hand?
instructions:
- text: Configure SAML for org {orgId} automatically from IdP {idpName}.
slots:
orgId: path.orgId
idpName: path.idpName
- text: Use the {idpName} integration to set up SAML SSO for organization {orgId}.
slots:
idpName: path.idpName
orgId: path.orgId
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.