API ReferenceSAML (IdP)
SAML (IdP mode)
Configure Avnology as a SAML 2.0 Identity Provider for downstream service providers.
SAML (Identity Provider mode)
When you want external apps (Atlassian, Zendesk, Slack, a customer app) to authenticate your users via SAML, Avnology plays the IdP role. The SamlService manages:
- Your tenant's IdP configuration (signing key, issuer URL, metadata).
- The registered service providers (ACS URLs, entity IDs, signature requirements).
- Per-SP attribute mappings that translate Avnology identity fields into SAML attributes.
- Certificate rotation.
- Test endpoints that generate a sample SAML assertion without an end-user flow.
Not to be confused with SSO connections -- those are for the reverse flow, where Avnology consumes an external SAML IdP.
Base URL: https://<Domain id="api"/>
Authentication: Bearer API key with saml_idp:write scope for mutations, :read for reads.
Sub-sections
| Area | What it covers |
|---|---|
| IdP Configuration | Global IdP settings, metadata download |
| Service Providers | CRUD for downstream SPs |
| Attribute Mappings | Per-SP claim-to-attribute translation |
| Certificates | Generate / activate / revoke signing certs |
| Assertion Testing | Validate or generate an assertion out of band |
Related components
- SSO -- Avnology as an SP (reverse flow)
- Self-service SSO setup guide