Elep

<h2>Overview</h2>
<span class="lead">
    [ADMIN] Turn IDM-mode on.
</span>

<h2>Summary</h2>
<span class="lead">
    This endpoint switches IDM mode on. This endpoint is only available to administrators when IDM migration is turned on and intended for internal use for IDM integration.
</span>

<h3>Request to enable IDM-mode.</h3>
<pre class="pre-scrollable">
{"idmMode": 
    {
        "enabled": true,
        "clientId": "mangoOIDCClientId",
        "clientSecret": "mangoOIDCClientSecret",
        "stsUrl": "http://sts.sugarcrm.local",
        "idpUrl": "http://login.sugarcrm.local",
        "stsKeySetId": "mangoOIDCKeySet",
        "tid": "srn:cloud:idp:eu:0000000001:tenant",
        "crmOAuthScope": "https://apis.sugarcrm.com/auth/crm",
        "requestedOAuthScopes": ["offline", "https://apis.sugarcrm.com/auth/crm", "profile", "email", "address", "phone"],
        "cloudConsoleUrl": "http://console.sugarcrm.local",
        "allowedSAs": ["srn:cloud:iam:us-west-2:9999999999:sa:user-sync"]
    }
}
</pre>
<p>
Refer to multiverse documenation for parameters explanation.
<strong>Deprecation Notice:</strong> "allowedSAs" will be removed the future versions.
</p>

<h3>Response when IDM mode has been enabled</h3>
<pre class="pre-scrollable">
{
    "tid": "srn:cloud:idp:eu:0000000001:tenant",
    "clientId": "mangoOIDCClientId",
    "clientSecret": "mangoOIDCClientSecret",
    "stsUrl": "http://sts.sugarcrm.local",
    "idpUrl": "http://login.sugarcrm.local",
    "redirectUri": "http://sugar",
    "urlAuthorize": "http://sts.sugarcrm.local/oauth2/auth",
    "urlAccessToken": "http://sts.sugarcrm.local/oauth2/token",
    "urlResourceOwnerDetails": "http://sts.sugarcrm.local/oauth2/introspect",
    "urlUserInfo": "http://sts.sugarcrm.local/userinfo",
    "http_client": [],
    "cloudConsoleUrl": "http://console.sugarcrm.local",
    "cloudConsoleRoutes": [],
    "caching": [],
    "crmOAuthScope": "https://apis.sugarcrm.com/auth/crm",
    "requestedOAuthScopes": [
        "offline",
        "https://apis.sugarcrm.com/auth/crm",
        "profile",
        "email",
        "address",
        "phone"
    ],
    "keySetId": "mangoOIDCKeySet",
    "urlKeys": "http://sts.sugarcrm.local/keys/mangoOIDCKeySet",
    "allowedSAs": ["srn:cloud:iam:us-west-2:9999999999:sa:user-sync"]
}
</pre>

<h2>Change Log</h2>
<table class="table table-hover">
    <tr>
        <th>Version</th>
        <th>Change</th>
    </tr>
    <tr>
        <td>
            v11_2
        </td>
        <td>
            Added <code>/Administration/settings/idmMode</code> POST endpoint.
        </td>
    </tr>
</table>