API ReferenceSAML (IdP)
IdP Configuration
Read and update your SAML IdP global configuration; download the IdP metadata XML.
RPCs
| Method | Path |
|---|---|
| GetConfiguration | GET /v1/saml/configuration |
| UpdateConfiguration | PATCH /v1/saml/configuration |
| DownloadMetadata | GET /v1/saml/configuration:metadata |
Base URL: https://<Domain id="api"/>
Authentication: Bearer token with saml_idp:read / :write.
Configuration shape
{
"entity_id": "https://<Domain id=\"saml\"/>/saml/idp",
"sso_url":
Download metadata
GET /v1/saml/configuration:metadata returns the XML metadata document SPs need to onboard your IdP. Set Accept: application/samlmetadata+xml.
Example
const res = await
req, _ := http.NewRequest("GET",
"https://api-id.avnology.net/v1/saml/configuration:metadata", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv
import httpx, os
res = httpx.get(
"https://api-id.avnology.net/v1/saml/configuration:metadata",
headers={
"Authorization": f"Bearer {os.environ['AVNOLOGY_API_KEY']}"
curl "https://api-id.avnology.net/v1/saml/configuration:metadata" \
-H "Authorization: Bearer $AVNOLOGY_API_KEY" \
-H "Accept: application/samlmetadata+xml"const res = await
req, _ := http.NewRequest("GET",
"https://api-id.avnology.net/v1/saml/configuration:metadata", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv
import httpx, os
res = httpx.get(
"https://api-id.avnology.net/v1/saml/configuration:metadata",
headers={
"Authorization": f"Bearer {os.environ['AVNOLOGY_API_KEY']}"
curl "https://api-id.avnology.net/v1/saml/configuration:metadata" \
-H "Authorization: Bearer $AVNOLOGY_API_KEY" \
-H "Accept: application/samlmetadata+xml"const res = await
req, _ := http.NewRequest("GET",
"https://api-id.avnology.net/v1/saml/configuration:metadata", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv
import httpx, os
res = httpx.get(
"https://api-id.avnology.net/v1/saml/configuration:metadata",
headers={
"Authorization": f"Bearer {os.environ['AVNOLOGY_API_KEY']}"
curl "https://api-id.avnology.net/v1/saml/configuration:metadata" \
-H "Authorization: Bearer $AVNOLOGY_API_KEY" \
-H "Accept: application/samlmetadata+xml"const res = await
req, _ := http.NewRequest("GET",
"https://api-id.avnology.net/v1/saml/configuration:metadata", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv
import httpx, os
res = httpx.get(
"https://api-id.avnology.net/v1/saml/configuration:metadata",
headers={
"Authorization": f"Bearer {os.environ['AVNOLOGY_API_KEY']}"