Versions Compared

Old Version 16

changes.mady.by.user CamilleCrespeau

Saved on

compared with

New Version Current

changes.mady.by.user CamilleCrespeau

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

 

 

your choice
FieldTypeRequired for
OpenID SSO		Required for
SAML SSO		Change with the tenant
and the environment		Defaults fieldsDescription
environmentstring - -Yes (with the env. only)-
The environment of the platform your are integrated to; accepted values:
- "test" (for the sandbox)
- "uat"
- "production"
app.hoststringYesYes

Yes (with the env. only)

-
Your application host
For UAT and Production environments, it must be a publicly resolvable URL
(you cannot use "http://localhost:3000" for instance)
api.idstringYesYesYes-
The id of your app
For maestrano.com integration, itIt corresponds to the App ID ofon your Maestrano App Provider API Dashboard
We will provide you the correct value for theother platform you are being connected to if it is different from Maestrano tenants than Maestrano
api.hoststringYesYesYesif "environment" is set:
value for Maestrano tenant
The platform host
We will provide you the correct value for theother platform you are being connected to if it is different from tenants than Maestrano
sso.idmstring - --same as config.app.host
Your Identity Domain Manager
sso.init_pathstring - YesYesyour choice

This value can be changed
on a per-tenant basis

-
Your application path that allows users to initiate the Single Sign-On handshake
We.
Upon reaching this endpoint your application will provide you the correct value for the platform you are being connected to if it is different from Maestrano  automatically 
create a SSO request and redirect the user to Maestrano.
Maestrano will then authenticate and authorize the user and send him back to your application.  
sso.consume_pathstring- Yesyour choiceThis value can be changed
on a per-tenant basis		-
Your application path to the SAML endpoint that allows users to finalize SSO authentication
During the 'consume' action your application sets users and group up and/or log them in.
sso.idpstringYesYesYes

if "environment" is set:
value for Maestrano tenant 

The platform host
We will provide you the correct value for theother platform you are being connected to if it is different from Maestrano tenants than Maestrano
 
sso.x509_fingerprintstring -YesYes

only if "environment" is set:
value for Maestrano tenant

We will provide you the correct value for theother platform you are being connected to if it is different from Maestrano tenants than Maestrano
sso.x509_certificatestring -YesYes

if "environment" is set:
value for Maestrano tenant

We will provide you the correct value for theother platform you are being connected to if it is different from Maestrano tenants than Maestrano
connec.hoststringYesYesYes

if "environment" is set:
value for Maestrano tenant

The Connec! endpoint used to fetch data from
We will provide you the correct value for theother platform you are being connected to if it is different from Maestrano tenants than Maestrano
 
webhook.account.groupgroups_pathstringYesYesyour choiceThis value can be changed
on a per-tenant basis		-
Your application path where a notification will be posted 
when an instance of your application is deleted
webhook.account.group_users_pathstringYesYesThis value can be changed
on a per-tenant basis		-
Your application path where a notification will be posted 
when a user is removed from an instance of your application
webhook.connec.notifications_pathstringYesYesyour choiceThis value can be changed
on a per-tenant basis		-
Your application path where notifications 
(created/updated entities) will be POSTed to
wenhookwebhook.connec.subscriptions

hash
keys: predefined entities
values: boolean

YesYesNofalse for all entities
The list of entities (organizations, people, invoices etc.) 
for which you want to be notified upon creation/update in Connec!™

 

...