---
title: "IdpSaml"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.ezghcloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: EZGH SSO API

## Fields

- `IdpSaml.emailAttribute` (string, required) — Empty: the NameID (emailAddress format) or a common email attribute.
- `IdpSaml.groupsAttribute` (string, required)
- `IdpSaml.identityProvider` (object | null, required)
  - `IdpSaml.identityProvider.certificates` (array<object>, required)
    - `IdpSaml.identityProvider.certificates.notAfter` (string, required)
      - format `date-time`
    - `IdpSaml.identityProvider.certificates.sha256` (string, required)
    - `IdpSaml.identityProvider.certificates.subject` (string, required)
  - `IdpSaml.identityProvider.entityId` (string, required)
  - `IdpSaml.identityProvider.ssoUrl` (string, required)
- `IdpSaml.metadataUrl` (string | null, required)
  - format `uri`
- `IdpSaml.serviceProvider` (object, required)
  - `IdpSaml.serviceProvider.acsUrl` (string, required)
  - `IdpSaml.serviceProvider.customDomainAcsUrls` (array<string>, required) — The ACS URLs on the directory's active custom domains (the entity ID stays the same). Federation started on a custom domain posts back there, so register them upstream as well; the metadata lists them.
    - format `uri`
  - `IdpSaml.serviceProvider.entityId` (string, required)
  - `IdpSaml.serviceProvider.metadataUrl` (string, required)


Source: https://docs.ezghcloud.com/sso-api/schemas/IdpSaml/index.md