Du kan konfigurere eksterne applikationer til at anvende kerneprodukt-funktionaliteten fra Workspace ONE UEM til ved at integrere REST API'er i UEM-infrastrukturen og facilitere forbindelse. Du kan også vælge en OAuth-token-URL-adresse, der er tættest på dit datacenter, til at godkende API-opkald.
Workspace ONE UEM REST API'er, der anvender en forenklet REST-softwarearkitektur, understøtter i øjeblikket flere funktioner, herunder organisationsgruppe, konsoladministration, mobil-app, mobilenhed, e-mail, tilmelding af bruger, profil, smart-gruppe og brugergruppeadministration.
Anvendelse af REST-baserede API'er giver flere fordele for virksomheder, inklusiv eliminering af omkostninger og tid, der bruges til udvikling af apps internt. Workspace ONE UEM REST API'er er fuldt ud i stand til og klar til at integrere med enterprise-servere, programmer og processer. Workspace ONE UEM REST API'er mere effektive, kører gnidningsløst og kan nemt brandes med virksomheder. Disse API'er er for app-udviklere. Denne guide giver en forståelse for design og arkitektur af API biblioteket og faciliterer brugerdefineret udvikling og integration med Workspace ONE UEM.
Gennemgå detaljeret API-dokumentation ved at navigere til siden API Hjælp i Workspace ONE UEM.
I adresselinjen i din browser skal du erstatte "cn" i URL-adressen med "as" og derefter tilføje /api/help
efter .com.
API-dokumentation for et SaaS-miljø kan f.eks. være en URL-adresse på…
https://cn4855.awmdm.com
…er…
https://as4855.awmdm.com/api/help
Workspace ONE UEM understøtter branchens standardmæssige OAuth 2.0-protokol for sikker godkendelse og godkendelse af REST API-kald.
Workspace ONE Token-tjeneste er Token-udstederen til OAuth-godkendelse og understøttes på nuværende tidspunkt kun i SaaS-miljøer. Token-URL-adresserne er regionsspecifikke.
Region | Workspace ONE UEM placering af SaaS-datacenter | Token-URL |
---|---|---|
Ohio (USA) | Alle UAT-miljøer | https://uat.uemauth.vmwservices.com/connect/token |
Virginia (USA) | USA | https://na.uemauth.vmwservices.com/connect/token |
Virginia (USA) | Canada | https://na.uemauth.vmwservices.com/connect/token |
Frankfurt (Tyskland) | Storbritannien | https://emea.uemauth.vmwservices.com/connect/token |
Frankfurt (Tyskland) | Tyskland | https://emea.uemauth.vmwservices.com/connect/token |
Tokyo (Japan) | Indien | https://apac.uemauth.vmwservices.com/connect/token |
Tokyo (Japan) | Japan | https://apac.uemauth.vmwservices.com/connect/token |
Tokyo (Japan) | Singapore | https://apac.uemauth.vmwservices.com/connect/token |
Tokyo (Japan) | Australien | https://apac.uemauth.vmwservices.com/connect/token |
Tokyo (Japan) | Hongkong | https://apac.uemauth.vmwservices.com/connect/token |
Du kan oprette en OAuth-klient til brug for API-kommandoer, der kun er understøttet i SaaS-miljøer. Opret en OAuth-klient til dit SaaS-miljø ved at gøre følgende.
OAuth
i søgefeltet, der er markeret med "Indtast et navn eller en kategori".Indtast Navn, Beskrivelse, Organisationsgruppe og Rolle.
Bemærk: Få flere oplysninger om specifikke REST API tilladelser for den rolle, du vælger, i afsnittet i dette emne med titlen Opret en rolle, der kan bruge REST API'er.
Sørg for, at Status er Aktiveret.
VIGTIGT: Kopier Klient-ID og Klienthemmelighed til udklipsholderen, og gem dem, før du lukker denne skærm. Vælg ikonet Kopier () for at sende Klienthemmeligheden til udklipsholderen.
Du kan ikke komme tilbage hertil for at hente disse oplysninger, efter du har valgt Luk.
Brug klient-id'et, klienthemmelighed og Token-URL'en til at generere adgangstoken i følgende format:
API-kald: POST {Regionsspecifik URL-adresse fra sektionen ovenfor}
Nøgle | Værdi |
---|---|
grant_type | client_credentials |
klient_id | {KLIENT-ID genereret på UEM-konsol} |
klient_hemmelighed | {KLIENTHEMMELIGHED genereret på UEM-konsol} |
Brug det returnerede adgangstoken til at autorisere fremtidige API-forespørgsler til Workspace ONE UEM API-servere. Du skal formatere adgangstoken i anmodningsheaderene på følgende måde.
API-kald: {UEM API}
Nøgle | Værdi |
---|---|
Godkendelse | {Adgangstoken} |
Hvert API-opkald, du vil foretage, har en tilsvarende ressource (eller tilladelse), som du skal inkludere i den rolle, du tildeler OAuth-klienten. Så tilladelser, der skal inkluderes i den rolle, du tildeler, passer med den type API-opkald, du foretager.
Anvend oplysningerne i følgende tabel til at hjælpe dig med at vælge, hvilke tilladelser du skal inkludere i den rolle, du tildeler. Gå derefter til afsnittet med titlen Opret administratorrolle i Rollebaseret adgang for at få instruktioner om, hvordan du opretter den pågældende rolle.
Kategori | Navn | Beskrivelse | Skrivebeskyttet/Rediger |
---|---|---|---|
REST > Admins | REST API systemgrupper | Adgang til organisationsgruppe info | Rediger |
REST API system admin | Adgang til admin info | Rediger | |
REST API system brugere | Adgang til bruger info | Rediger | |
REST API - Skriv admins | Giver adgang til alle Skriv/opdater-API'er i adminbrugersamling | Rediger | |
REST API - Udfør admins | Giver adgang til alle Udfør-API'er i adminbrugersamling | Rediger | |
REST API - Slet admin | Giver adgang til alle Slet-API'er i adminbrugersamling | Rediger | |
REST API - Læs admin | Giver adgang til alle Skrivebeskyt-API'er i adminbrugersamling | Skrivebeskyttet | |
REST > Apps | REST API MAM BLOB | Upload/download indhold | Rediger |
REST API MAM apps | Adgang til styrede apps | Rediger | |
REST API - Skriv apps | Giver adgang til alle Skriv/rediger-API'er i appsamling | Rediger | |
REST API - Udfør apps | Giver adgang til alle Udfør-API'er i appsamling | Rediger | |
REST API - Slet apps | Giver adgang til alle Slet-API'er i appsamlingen | Rediger | |
REST API - Læs apps | Giver adgang til alle Skrivebeskyt-API'er i appsamling | Skrivebeskyttet | |
REST > Compliance-politik | REST API compliance-politik slet | Aktivere adgang til alle Slet APIer i compliance-politik samling | Rediger |
REST API compliance-politik udfør | Aktivere adgang til alle Udfør APIer i compliance-politik samling | Rediger | |
REST API compliance-politik skriv | Aktivere adgang til alle Skriv kun APIer compliance-politik samling | Rediger | |
REST API compliance-politik læs | Aktivere adgang til alle Læs kun APIer compliance-politik samling | Skrivebeskyttet | |
REST > Brugerdefinerede attributter | Udfør REST API brugerdefinerede attributter | Aktiverer adgang til alle APIs som kan udføres i brugerdefinerede attribut samling | Rediger |
Skriv REST API brugerdefinerede attributter | Aktiverer adgang til alle skrivbare API'er i brugerdefineret attributsamling | Rediger | |
Slet REST API brugerdefinerede attributter | Aktiverer adgang til alle slettede APIs i brugerdefinerede attribut samling | Rediger | |
Læs REST API brugerdefinerede attributter | Aktiverer adgang til alle READ only APIs i brugerdefineret attribut samlingen | Skrivebeskyttet | |
REST > Enheder | REST API MDM smart-grupper | Adgang til smart-gruppe information | Rediger |
REST API MDM brugergrupper | Adgang til brugergrupper | Rediger | |
REST API MDM profiler | Send kommandoer for låsning/oplåsning | Rediger | |
REST API MDM enheder | Send kommandoer for låsning/oplåsning | Rediger | |
Skriv REST API BLOBS | Aktiverer adgang til alle Skriv/opdater kun APIs i BLOBS samlingen | Rediger | |
Udfør REST API BLOBS | Aktiverer adgang til alle Udfør kun APIs i BLOBS samlingen | Rediger | |
Slet REST API BLOBS | Aktiverer adgang til alle Slet kun APIs i BLOBS samlingen | Rediger | |
REST API – Skriv enheder | Giver adgang til alle Skriv/rediger-API'er i enhedssamling | Rediger | |
REST API - Udfør enheder | Giver adgang til alle Udfør-API'er i enhedssamling | Rediger | |
REST API – Slet enheder | Giver adgang til alle Slet-API'er i enhedssamling | Rediger | |
REST API – Avancerede enheder | Giver adgang til alle Avanceret-API'er i enhedssamling | Rediger | |
Læs REST API BLOBS | Aktiverer adgang til alle Læs kun APIs i BLOBS samlingen | Skrivebeskyttet | |
REST API - Læs enheder | Giver adgang til alle Skrivebeskyt-API'er i enhedssamling | Skrivebeskyttet | |
REST > REST Enterprise Integration | REST API Enterprise Integration læsning | Aktiverer adgang til skrivebeskytted APIs i Enterprise integration | Skrivebeskyttet |
REST > Grupper | REST API - Skriv grupper | Giver adgang til alle Skriv/opdater-API'er i organisationsgruppesamling | Rediger |
REST API - Udfør grupper | Giver adgang til alle Udfør-API'er i organisationsgruppesamling | Rediger | |
REST API - Slet grupper | Giver adgang til alle Slet-API'er i organisationsgruppesamling | Rediger | |
Skriv REST API smart-gruppe | Giver adgang til alle Skriv-API'er i smart-gruppesamling | Rediger | |
Udfør REST API smart-gruppe | Giver adgang til alle Udfør-API'er i smart-gruppesamlinger | Rediger | |
Slet REST API smart-gruppe | Giver adgang til alle Slet-API'er i smart-gruppesamling | Rediger | |
Skriv REST API brugergrupper | Giver adgang til alle Skriv/opdater-API'er i brugergrupper | Rediger | |
Udfør REST API brugergrupper | Giver adgang til alle Udfør-API'er i brugergrupper | Rediger | |
Slet REST API brugergrupper | Giver adgang til alle Slet-API'er i brugergrupper | Rediger | |
REST API Cart, skriv | REST API for at gemme og redigere vogndata | Rediger | |
REST API Cart, slet | REST API for at slette vogndata | Rediger | |
REST API Apple School Manager, skrive | REST API for at initiere Apple School Manager-synkronisering | Rediger | |
REST API Apple School Manager-kort | REST API for at kortlægge en tilmeldingsbruger til et medlem fra Apple School Manager | Rediger | |
REST API Class Assignments, gem | REST API opkald for at gemme klassetildelinger | Rediger | |
REST API Class, skriv | REST API for gemme og redigere klassedata | Rediger | |
REST API Class, slet | REST API for at slette klassedata | Rediger | |
REST API Education-indstillinger, skriv | REST API for at gemme og redigere Education indstillinger | Rediger | |
REST API Education-indstillinger, læs | REST API for at vise Education indstillinger | Rediger | |
REST API - Læs grupper | Giver adgang til alle Skrivebeskyt-API'er i Organisationsgruppesamling | Skrivebeskyttet | |
Læs REST API smart-gruppe | Giver adgang til alle Skrivebeskyt-API'er i smart-gruppesamling | Skrivebeskyttet | |
Læs REST API brugergrupper | Giver adgang til alle Skrivebeskyt-API'er i brugergrupper | Skrivebeskyttet | |
REST API Apple School Manager-synkronisering, læse | REST API for at tjekke Apple School Manager synkroniseringsstatus | Skrivebeskyttet | |
REST API apps for Læs enhed | REST API for at modtage en liste over apps tilgængelige for enhed | Skrivebeskyttet | |
REST API Class, læs | REST API for at vise klassedata | Skrivebeskyttet | |
REST > Produkter | REST API produkter udfør | Giver adgang til alle Udfør-API'er i produktsamling | Rediger |
REST API produkter skriv | Giver adgang til alle Skriv-API'er i produktsamling | Rediger | |
REST API produkter slet | Giver adgang til alle Slet-API'er i produktsamling | Rediger | |
REST API produkter læs | Giver adgang til alle Skrivebeskyt-API'er i produktsamling | Skrivebeskyttet | |
REST > Profiler | Opdaterer politik for skriveadgang | Aktiverer adgang til alle SKRIV API'er i opdateringspolitiksamling | Rediger |
Opdaterer politik for udførelsesadgang | Aktiverer adgang til alle UDFØR API'er i opdateringspolitiksamling | Rediger | |
Opdaterer politik for sletteadgang | Aktiverer adgang til alle SLET API'er i opdateringspolitiksamling | Rediger | |
REST API profiler - skriv | Giver adgang til alle Skriv-API'er i profillisten | Rediger | |
REST API profile - udfør | Giver adgang til alle Udfør-API'er i profilsamling | Rediger | |
REST API profiler - slet | Giver adgang til alle Slet-API'er i profilsamling | Rediger | |
Opdaterer politik for skrivebeskyttet adgang | Aktiverer adgang til alle SKRIVEBESKYTTET API'er i opdateringspolitiksamling | Skrivebeskyttet | |
REST API profiler - læs | Giver adgang til alle Skrivebeskyt-API'er i profilsamling | Skrivebeskyttet | |
REST > Brugere | REST API - Skriv brugere | Giver adgang til alle Skriv/opdater-API'er i brugertilmeldingssamling | Rediger |
REST API - Udfør brugere | Giver adgang til alle Udfør-API'er i brugertilmeldingsamling | Rediger | |
REST API - Slet brugere | Giver adgang til alle Slet-API'er i brugertilmeldingssamling | Rediger | |
REST API brugertokens læst | Giver adgang til brugertokens for tilmelding for APIer i tilmeldingsbruger samlingen | Skrivebeskyttet | |
REST API - Læs brugere | Giver adgang til alle Skrivebeskyt-API'er i brugertilmeldingssamling | Skrivebeskyttet |