Dela via

Utöka API-driven etablering för att synkronisera anpassade attribut

  • Artikel

Som standard stöder API-drivna etableringsappar bearbetningsattribut som ingår i standardschemat för SCIM Core-användare och företagsanvändare. Ditt postsystem kan ha anpassade attribut som du kanske vill inkludera som en del av API-driven etablering. Den här avancerade självstudien beskriver hur du utökar din API-drivna etableringsapp för att bearbeta ytterligare anpassade attribut.

Kommentar

Innan du provar det här avancerade scenariot rekommenderar vi att du kontrollerar att din färdiga konfiguration av etableringsappen fungerar som förväntat med någon av följande API-klienter Graph Explorer, cURL.

Exempelscenario

Du har konfigurerat en API-driven etableringsapp. Du etablerar appen använder de attribut som ingår i SCIM Core-standardschemat för användare och företagsanvändare och etablerar användare i Microsoft Entra-ID. Nu vill du skicka två anpassade attribut HireDate och JobCode från HR-systemet till API-slutpunkten för inkommande etablering. Du vill mappa dessa två anpassade attribut till Microsoft Entra-attribut employeeHireDate och jobTitle.

Steg 1 – Utöka schemat för etableringsappen

I det här steget lägger vi till de två attributen "HireDate" och "JobCode" som inte ingår i SCIM-standardschemat i etableringsappen och använder dem i etableringsdataflödet.

  1. Logga in på administrationscentret för Microsoft Entra som minst programadministratör.
  2. Bläddra till Identity>Applications Enterprise-program.>
  3. Öppna din API-drivna etableringsapp.
  4. Öppna bladet Etablering.
  5. Klicka på knappen Redigera etablering .
  6. Expandera avsnittet Mappningar och klicka på länken för attributmappning.
    Skärmbild av mappning av redigeringsattribut.
  7. Rulla nedåt på sidan Attributmappningar . Välj Visa avancerade alternativ och klicka på länken Redigera attribut för API . Skärmbild av redigera API-attributlistan.
  8. Rulla ned till slutet av sidan Redigera attributlista .
  9. Lägg till följande två attribut i listan som SCIM-schematillägg. Du kan använda ditt eget SCIM-schemanamnområde.
    urn:ietf:params:scim:schemas:extension:contoso:1.0:User:HireDate
    urn:ietf:params:scim:schemas:extension:contoso:1.0:User:JobCode
    Skärmbild av att lägga till anpassade attribut.
  10. Spara ändringarna

Kommentar

Om du bara vill lägga till några ytterligare attribut i etableringsappen använder du administrationscentret för Microsoft Entra för att utöka schemat. Om du vill lägga till fler anpassade attribut (låt oss säga 20+ attribut) rekommenderar vi att du använder UpdateSchema läget för CSV2SCIM PowerShell-skript som automatiserar ovanstående manuella process.

Steg 2 – Mappa anpassade attribut

Nu ska vi lägga till dessa tillägg i attributmappningen för etableringsappen.

  1. Klicka på länken Lägg till ny mappning på sidan Attributmappning . Skärmbild av lägg till ny mappning.

  2. Mappa attributet urn:ietf:params:scim:schemas:extension:contoso:1.0:User:HireDate till employeeHireDate. Klicka på OK.
    Skärmbild av mappning av anställningsdatum.

  3. Välj sedan den befintliga mappningen för och klicka på den för title att redigera mappningen.

  4. Redigera attributmappningen till ett uttryck som ska inkludera urn:ietf:params:scim:schemas:extension:contoso:1.0:User:JobCode som en del av jobTitle Microsoft Entra-attributet.

      Join("", [title], "(", [urn:ietf:params:scim:schemas:extension:contoso:1.0:User:JobCode], ")")

    Skärmbild av mappning av jobbrubriker.

    Med den här uttrycksmappningen, om title är "Tour Lead" och JobCodeär "TL-1001", ställs Microsoft Entra-attributet jobTitle in på "Tour Lead (TL-1001)".

  5. Spara attributmappningarna.

Steg 3 – Ladda upp massbegäran med anpassade attribut

  1. Öppna API-klienten (Graph Explorer/cURL).
  2. Kopiera och klistra in massbegäran med anpassade attribut.
  3. Skicka massbegäran till din API-slutpunkts-URL för etablering.
    Skärmbild av massuppladdningsbegäran.
  4. Efter en tid kan du kontrollera etableringsloggarna för att verifiera attributändringen.
    Skärmbild av etableringsloggar.
  5. Du kan också verifiera ändringen i Microsoft Entra-användarprofilen. Värdet för Employee hire date återspeglar din klientorganisations tidszon.
    Skärmbild av användarprofil.

Bilaga

Massbegäran med anpassade attribut

Massbegäran innehåller de anpassade attribut som konfigurerats i stegen ovan.

Begärandetext

{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:BulkRequest"],
    "Operations": [
    {
        "method": "POST",
        "bulkId": "701984",
        "path": "/Users",
        "data": {
            "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User",
            "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
            "urn:ietf:params:scim:schemas:extension:contoso:1.0:User"],
            "externalId": "701984",
            "userName": "bjensen@example.com",
            "name": {
                "formatted": "Ms. Barbara J Jensen, III",
                "familyName": "Jensen",
                "givenName": "Barbara",
                "middleName": "Jane",
                "honorificPrefix": "Ms.",
                "honorificSuffix": "III"
            },
            "displayName": "Babs Jensen",
            "nickName": "Babs",
            "emails": [
            {
              "value": "bjensen@example.com",
              "type": "work",
              "primary": true
            }
            ],
            "addresses": [
            {
              "type": "work",
              "streetAddress": "234300 Universal City Plaza",
              "locality": "Hollywood",
              "region": "CA",
              "postalCode": "91608",
              "country": "USA",
              "formatted": "100 Universal City Plaza\nHollywood, CA 91608 USA",
              "primary": true
            }
            ],
            "phoneNumbers": [
            {
              "value": "555-555-5555",
              "type": "work"
            }
            ],
            "userType": "Employee",
            "title": "Tour Guide",
            "preferredLanguage": "en-US",
            "locale": "en-US",
            "timezone": "America/Los_Angeles",
            "active":true,
            "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
                "employeeNumber": "701984",
                "costCenter": "4130",
                "organization": "Universal Studios",
                "division": "Theme Park",
                "department": "Tour Operations",
                "manager": {
                  "value": "89607",
                  "displayName": "John Smith"
                 }
            },
            "urn:ietf:params:scim:schemas:extension:contoso:1.0:User": {
                "HireDate": "2021-05-01T00:00:00-05:00",
                "JobCode": "TG-1001"
            }            
        }
    },
    {
        "method": "POST",
        "bulkId": "701985",
        "path": "/Users",
        "data": {
            "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User",
            "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
            "urn:ietf:params:scim:schemas:extension:contoso:1.0:User"],
            "externalId": "701985",
            "userName": "Kjensen@example.com",
            "name": {
                "formatted": "Ms. Kathy J Jensen, III",
                "familyName": "Jensen",
                "givenName": "Kathy",
                "middleName": "Jane",
                "honorificPrefix": "Ms.",
                "honorificSuffix": "III"
            },
            "displayName": "Kathy Jensen",
            "nickName": "Kathy",
            "emails": [
            {
              "value": "kjensen@example.com",
              "type": "work",
              "primary": true
            }
            ],
            "addresses": [
            {
              "type": "work",
              "streetAddress": "100 Oracle City Plaza",
              "locality": "Hollywood",
              "region": "CA",
              "postalCode": "91618",
              "country": "USA",
              "formatted": "100 Oracle City Plaza\nHollywood, CA 91618 USA",
              "primary": true
            }
            ],
            "phoneNumbers": [
            {
              "value": "555-555-5545",
              "type": "work"
            }
            ],
            "userType": "Employee",
            "title": "Tour Lead",
            "preferredLanguage": "en-US",
            "locale": "en-US",
            "timezone": "America/Los_Angeles",
            "active":true,
            "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
              "employeeNumber": "701984",
              "costCenter": "4130",
              "organization": "Universal Studios",
              "division": "Theme Park",
              "department": "Tour Operations",
              "manager": {
                "value": "701984",
                "displayName": "Barbara Jensen"
             }
            },
            "urn:ietf:params:scim:schemas:extension:contoso:1.0:User": {
                "HireDate": "2022-07-15T00:00:00-05:00",
                "JobCode": "TL-1003"
            }            
        }
    }
],
    "failOnErrors": null
}

Nästa steg