...
Required fields in your metadata, depending on the SSO protocol you have chosen:
FieldOpenID | Type | SAMLRequired for | environmentOpenID SSO | Required for | ||
---|---|---|---|---|---|---|
app.host | YES | YES | ||||
api.id | YES | YES | ||||
api.host | YES | YES | ||||
sso.idm | ||||||
sso.init_path | YES | |||||
sso.consume_path | YES | |||||
sso.idp | YES | YES | ||||
sso.x509_fingerprint | YES | |||||
sso.x509_certificate | YES | |||||
connec.host | YES | YES | ||||
webhook.account.group_path | YES | YES | ||||
webhook.account.group_users_path | YES | YES | ||||
webhook.connec.notifications_path | YES | YES | ||||
wenhook.connec.subscriptions | YES | YESSAML 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 | - | The platform host |
sso.idm | string | - | - | - | same as config.app.host | Your Identity Domain Manager |
sso.init_path | string | - | Yes | your choice | - | Your application path that allows users to initiate |
sso.consume_path | string | - | Yes | your choice | - | Your application path to the SAML endpoint that allows |
sso.idp | string | Yes | Yes | Yes | if "environment" is set: | The platform host |
sso.x509_fingerprint | string | - | Yes | Yes | only if "environment" is set: | |
sso.x509_certificate | string | - | Yes | Yes | if "environment" is set: | |
connec.host | string | Yes | Yes | Yes | if "environment" is set: | The Connec! endpoint used to fetch data from |
webhook.account.group_path | string | Yes | Yes | your choice | - | Your application path where a notification will be posted |
webhook.account.group_users_path | string | Yes | Yes | your choice | - | Your application path where a notification will be posted |
webhook.connec.notifications_path | string | Yes | Yes | your choice | - | Your application path where notifications |
wenhook.connec.subscriptions | hash | Yes | Yes | No | false for all entities | The list of entities (organizations, people, invoices etc.) |
...
2 - Single Sign-On
Status | ||||||||
---|---|---|---|---|---|---|---|---|
|
...