SAML SSO -palveluntarjoajan integrointi ulkoisena asiakassovelluksena

Ulkoisen ylätason asiakassovelluksen luominen

<?xml version="1.0" encoding="UTF-8"?>
<ExternalClientApplication xmlns="http://soap.sforce.com/2006/04/metadata">
    <contactEmail>johndoe@example.com</contactEmail>
    <description>SAML external client app to integrate third-party service provider</description>
    <distributionState>Local</distributionState>
    <isProtected>false</isProtected>
    <label>mysamleca</label>
</ExternalClientApplication>

Ulkoisten asiakassovellusten käytäntöjen kokoonpanon luominen

1. Luo <projektin hakemistoon>/force-app/main/default/ hakemisto nimeltään extlClntAppPolicies.
2. Luo extlClntAppPolicies-osiosta tiedosto nimeltään <ECA-käytännön nimi>.ecaPlcy-meta.xml.
3. Määritä <ECA-käytännön nimi>.ecaPlcy-meta.xml-tiedosto näillä kentillä.

   Kenttä	Kuvaus
   externalClientApplication	Ulkoisen pääasiakassovelluksen nimi, joka on määritetty sen otsikkokentässä.
   isEnabled	Määrittää, voiko ulkoinen asiakassovellus käyttää lisäosia. Määritä kentäksi true.
   isOauthPluginEnabled	Määrittää, voiko ulkoinen asiakassovellus käyttää OAuth-lisäosaa. Koska lisäosa isEnabled ottaa automaattisesti kaikki lisäosat käyttöön ja tämä sovellus on tarkoitettu vain SAML:lle, määritä kentäksi false.
   isSamlPluginEnabled	Määrittää, voiko ulkoinen asiakassovellus käyttää SAML-lisäosaa. Määritä kentäksi true.
   label	Määritettävien käytäntöjen nimi.

   Alla on esimerkki <ECA-käytännön nimestä>.ecaPlcy-meta.xml-tiedostosta.

   <?xml version="1.0" encoding="UTF-8"?>
          <ExtlClntAppConfigurablePolicies xmlns="http://soap.sforce.com/2006/04/metadata">
           <externalClientApplication>mysamleca</externalClientApplication>
           <isEnabled>true</isEnabled>
           <isSamlPluginEnabled>true</isSamlPluginEnabled>
           <isOauthPluginEnabled>false</isOauthPluginEnabled>
           <label>myecapolicy</label>
          </ExtlClntAppConfigurablePolicies>

Ulkoisen asiakassovelluksen SAML-käytäntöjen kokoonpanon luominen

1. Luo <projektin hakemistoon>/force-app/main/default/ hakemisto nimeltään extlClntAppSamlConfigurablePolicies.
2. Luo extlClntAppSamlConfigurablePolicies-osiossa tiedosto nimeltään <ECA SAML -käytännön nimi>.ecaSamlPlcy-meta.xml.
3. Määritä kentät <ECA SAML -käytännön nimelle>.ecaSamlPlcy-meta.xml-tiedostolle.
   Lisätietoja sisällytettävistä kentistä on Metadata API -viiteoppaan ExtlClntAppSamlConfigurablePolicies-metadatatyypissä.
   Alla on esimerkki <ECA SAML -käytännön nimestä>.ecaSamlPlcy-meta.xml-tiedosto. Tämä määritelmä sisältää mukautetut attribuutit, jotka on määritetty ExtlClntAppSamlConfigurablePoliciesAttribute-alatyypeissä.

   <?xml version="1.0" encoding="UTF-8"?>
   <ExtlClntAppSamlConfigurablePolicies xmlns="http://soap.sforce.com/2006/04/metadata">
       <acsUrl>https://www.<serviceprovideracsurl>.com</acsUrl>
       <entityUrl>https://www.<serviceproviderentityid>.com</entityUrl>
       <externalClientApplication>mysamleca</externalClientApplication>
       <issuer>https://mydomainname.my.salesforce.com</issuer>
       <label>myeca_samlpolicies</label>
       <nameIdFormat>Unspecified</nameIdFormat>
       <singleLogoutUrl>https://www.<serviceprovidersinglelogouturl>.com</singleLogoutUrl>
       <singleLogoutBindingType>RedirectBinding</singleLogoutBindingType>
       <subjectType>CustomAttribute</subjectType>
       <subjectCustomAttribute>MyCustomField</subjectCustomAttribute>
       <certificate>MIIDzDCCArQCCQCFaZKGsGqZ...</certificate>
       <encryptionCertificate>MIIDzDCCArQCCQCFaZKGsGqZ...</encryptionCertificate>
       <encryptionType>AES_128</encryptionType>
       <signingAlgorithmType>SHA1</signingAlgorithmType>
       <customAttributes>
           <key>User Firstname</key>
           <formula>$User.FirstName</formula>
       </customAttributes>
       <customAttributes>
           <key>User Country</key>
           <formula>$User.Country</formula>
       </customAttributes>
   </ExtlClntAppSamlConfigurablePolicies>

Package.xml-tiedoston luominen

1. Luo <projektin hakemistoon> tiedosto nimeltään package.xml. Älä luo alikansiota tälle tiedostolle. Tiedoston rakenne näyttää tältä.
   
2. Lisää viitteet ExternalClientApplication-, ExtlClntAppConfigurablePolicies- ja ExtlClntAppSamlConfigurablePolicies-metadatatyyppeihin package.xml-tiedostoon.
   Alla on esimerkki package.xml-tiedostosta.

   <?xml version="1.0" encoding="UTF-8"?>
   <Package xmlns="http://soap.sforce.com/2006/04/metadata">
       <types>
           <members>*</members>
           <name>ExternalClientApplication</name>
       </types>
       <types>
           <members>*</members>
           <name>ExtlClntAppConfigurablePolicies</name>
       </types>
       <types>
           <members>*</members>
           <name>ExtlClntAppSamlConfigurablePolicies</name>
       </types>
       <version>63.0</version>
   </Package>

SAML-yhteensopivan ulkoisen asiakassovelluksen käyttöönotto

Siirrä muutokset paikallisesta projektin hakemistosta Salesforceen.

1. Avaa uusi terminaali-ikkuna.
2. Siirry <projektin hakemistoon>.
3. Suorita tämä komento ottaaksesi package.xml-tiedoston käyttöön.

   sf project deploy start --manifest package.xml -o <username@targetorg.com>

4. Suorita tämä komento varmistaaksesi, että metadata on otettu käyttöön oikein.

   sf project retrieve start --source-dir force-app -o <username@targetorg.com>

   Kun ulkoinen asiakassovellus on otettu käyttöön, näet sen Määritykset-valikon Ulkoisten asiakassovellusten hallinta -osiossa. Et voi kuitenkaan tarkastella tai muokata sen SAML-kokoonpanotietoja Määritykset-valikosta.

SAML-yhteensopivan ulkoisen asiakassovelluksen muokkaaminen

Tee tarvittaessa muutoksia ulkoisen asiakassovelluksesi SAML-kokoonpanoon.

1. Päivitä vastaavat metadatakomponenttitiedostot <projektin hakemistostasi>/force-app/main/default/ directory.
   • Jos haluat päivittää ulkoisen asiakassovelluksen yleisiä tietoja, kuten sen kuvausta tai yhteyshenkilön sähköpostia, muokkaa sen <ulkoisen asiakassovelluksen nimeä>.eca-meta.xml-tiedostoa.
   • Jos haluat päivittää ulkoisen asiakassovelluksen käytännöt, kuten käytäntöjen komponentin otsikon, muokkaa <ECA-käytännön nimi>.ecaPlcy-meta.xml-tiedostoa.
   • Jos haluat päivittää SAML-kokoonpanon tiedot, muokkaa tiedostoa <ECA SAML policy name>.ecaSamlPlcy-meta.xml.
2. Jos haluat siirtää muutokset Salesforceen, ota package.xml-tiedosto uudelleen käyttöön suorittamalla tämä komento.

   sf project deploy start --manifest package.xml -o <username@targetorg.com>

   Suorita tämä vaihe, vaikka muokkaisit vain yhtä komponenttia. Et voi ottaa yhtä komponenttia käyttöön.
3. Suorita tämä komento varmistaaksesi, että metadata on otettu käyttöön oikein.

   sf project retrieve start --source-dir force-app -o <username@targetorg.com>