Delen via

API-gestuurde inrichting uitbreiden om aangepaste kenmerken te synchroniseren

  • Artikel

Api-gestuurde inrichtingsapps ondersteunen standaard verwerkingskenmerken die deel uitmaken van het standaardschema scim Core-gebruiker en enterprisegebruiker. Uw systeem van record heeft mogelijk aangepaste kenmerken die u mogelijk wilt opnemen als onderdeel van API-gestuurde inrichting. In deze geavanceerde zelfstudie wordt beschreven hoe u uw API-gestuurde inrichtings-app kunt uitbreiden om aanvullende aangepaste kenmerken te verwerken.

Notitie

Voordat u dit geavanceerde scenario probeert, raden we u aan te controleren of de out-of-the-box inrichtings-app-configuratie werkt zoals verwacht met behulp van een van de volgende API-clients Graph Explorer, cURL.

Voorbeeldscenario

U hebt api-gestuurde inrichtings-app geconfigureerd. U gebruikt de inrichtings-app met succes met de kenmerken die deel uitmaken van het standaardschema scim Core-gebruiker en enterprisegebruiker en het inrichten van gebruikers in Microsoft Entra-id. U wilt nu twee aangepaste kenmerken HireDate en JobCode van uw HR-systeem verzenden naar het eindpunt van de inkomende inrichtings-API. U wilt deze twee aangepaste kenmerken toewijzen aan Microsoft Entra-kenmerken employeeHireDate en jobTitle.

Stap 1: het schema van de inrichtings-app uitbreiden

In deze stap voegen we de twee kenmerken 'HireDate' en 'JobCode' toe die geen deel uitmaken van het standaard SCIM-schema voor de inrichtings-app en gebruiken ze in de inrichtingsgegevensstroom.

  1. Meld u als toepassingsbeheerder aan bij het Microsoft Entra-beheercentrum.
  2. Blader naar Bedrijfstoepassingen voor identiteitstoepassingen>>.
  3. Open uw API-gestuurde inrichtings-app.
  4. Open de blade Inrichten .
  5. Klik op de knop Inrichting bewerken .
  6. Vouw de sectie Toewijzingen uit en klik op de koppeling voor kenmerktoewijzing.
    Schermopname van kenmerktoewijzing bewerken.
  7. Schuif omlaag op de pagina Kenmerktoewijzingen . Selecteer Geavanceerde opties weergeven en klik op de lijst Kenmerken bewerken voor API-koppeling . Schermopname van de lijst met API-kenmerken bewerken.
  8. Schuif omlaag naar het einde van de pagina Kenmerkenlijst bewerken.
  9. Voeg de volgende twee kenmerken toe aan de lijst als SCIM-schema-extensies. U kunt uw eigen SCIM-schemanaamruimte gebruiken.
    urn:ietf:params:scim:schemas:extension:contoso:1.0:User:HireDate
    urn:ietf:params:scim:schemas:extension:contoso:1.0:User:JobCode
    Schermopname van het toevoegen van aangepaste kenmerken.
  10. Uw wijzigingen opslaan

Notitie

Als u slechts enkele extra kenmerken aan de inrichtings-app wilt toevoegen, gebruikt u het Microsoft Entra-beheercentrum om het schema uit te breiden. Als u meer aangepaste kenmerken wilt toevoegen (bijvoorbeeld 20+ kenmerken), raden we u aan de UpdateSchema modus van het CSV2SCIM PowerShell-script te gebruiken waarmee het bovenstaande handmatige proces wordt geautomatiseerd.

Stap 2: de aangepaste kenmerken toewijzen

We gaan deze extensies nu toevoegen aan de toewijzing van het kenmerk van de inrichtings-app.

  1. Klik op de koppeling Nieuwe toewijzing toevoegen op de pagina Kenmerktoewijzing . Schermopname van nieuwe toewijzing toevoegen.

  2. Wijs het urn:ietf:params:scim:schemas:extension:contoso:1.0:User:HireDate kenmerk toe aan employeeHireDate. Klik op OK.
    Schermopname van toewijzing van huurdatums.

  3. Selecteer vervolgens de bestaande toewijzing voor title en klik erop om de toewijzing te bewerken.

  4. Bewerk de kenmerktoewijzing aan een expressie die het urn:ietf:params:scim:schemas:extension:contoso:1.0:User:JobCode onderdeel van het jobTitle Kenmerk Microsoft Entra bevat.

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

    Schermopname van de toewijzing van functietitels.

    Als deze expressietoewijzing ' title Rondleidingsleider' is en JobCodeTL-1001 is, wordt het kenmerk jobTitle Microsoft Entra ingesteld op 'Tour Lead (TL-1001)'.

  5. Sla de kenmerktoewijzingen op.

Stap 3: Bulkaanvraag uploaden met aangepaste kenmerken

  1. Open uw API-client (Graph Explorer/cURL).
  2. Kopieer en plak de bulkaanvraag met aangepaste kenmerken.
  3. Verzend de bulkaanvraag naar de URL van uw inrichtings-API-eindpunt.
    Schermopname van aanvraag voor bulksgewijs uploaden.
  4. Na enige tijd kunt u de inrichtingslogboeken controleren om de wijziging van het kenmerk te controleren.
    Schermopname van het inrichten van logboeken.
  5. U kunt ook de wijziging in het Microsoft Entra-gebruikersprofiel controleren. De waarde voor het weergeven van de tijdzone van Employee hire date uw tenant.
    Schermopname van gebruikersprofiel.

Bijlage

Bulkaanvraag met aangepaste kenmerken

De bulkaanvraag bevat de aangepaste kenmerken die zijn geconfigureerd in de bovenstaande stappen.

Aanvraagbody

{
    "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
}

Volgende stappen