...
The metadata endpoint should return a JSON document describing your configuration. Note that the call initiated by Maestrano to retrieve your metadata is authenticated via HTTP Basic authentication using your own API credentials (shared secret).
Warning |
---|
The |
...
fields |
...
listed below are listed in Snake case. As our SDKs respect languages conventions, fields' names may vary from an SDK to another (e.g.: Java SDK). Please, refer to your SDK documentation for the exact names to use. |
Field | Type | Required for OpenID SSO | Required for SAML SSO | Change with the tenant and the environment | Defaults fields | Description |
---|---|---|---|---|---|---|
environment | string | - | - | Yes (with the env. only) | - | The environment of the platform your are integrated to; accepted values: |
app.host | string | Yes | Yes | Yes (with the env. only) | - | Your application host |
api.id | string | Yes | Yes | Yes | - | The id of your app |
api.host | string | Yes | Yes | Yes | if "environment" is set: value for Maestrano tenant | The platform host |
sso.idm | string | - | - | - | same as config.app.host | Your Identity Domain Manager |
sso.init_path | string | Yes | Yes | This value can be changed | - | Your application path that allows users to initiate the Single Sign-On handshake. Upon reaching this endpoint your application will automatically |
sso.consume_path | string | - | Yes | This value can be changed on a per-tenant basis | - | Your application path to the SAML endpoint that allows users to finalize SSO authentication |
sso.idp | string | Yes | Yes | Yes | if "environment" is set: | The platform host |
sso.x509_fingerprint | string | - | Yes | Yes | if "environment" is set: | We will provide you the correct value for other tenants than Maestrano |
sso.x509_certificate | string | - | Yes | Yes | if "environment" is set: | We will provide you the correct value for other tenants than Maestrano |
connec.host | string | Yes | Yes | Yes | if "environment" is set: | The Connec! endpoint used to fetch data from |
webhook.account.groups_path | string | Yes | Yes | This value can be changed on a per-tenant basis | - | Your application path where a notification will be posted |
webhook.account.group_users_path | string | Yes | Yes | This value can be changed on a per-tenant basis | - | Your application path where a notification will be posted |
webhook.connec.notifications_path | string | Yes | Yes | This value can be changed on a per-tenant basis | - | Your application path where notifications |
webhook.connec.subscriptions | hash | Yes | Yes | No | false for all entities | The list of entities (organizations, people, invoices etc.) |
...