Service Principals - List

Referenz

Service:: Graph

API Version:: 7.1-preview.1

Ruft eine Liste aller Dienstprinzipale in einem bestimmten Bereich ab.

Da die Liste der Dienstprinzipale groß sein kann, werden Ergebnisse auf Seiten von Dienstprinzipalen zurückgegeben. Wenn mehr Ergebnisse vorhanden sind, als auf einer einzelnen Seite zurückgegeben werden können, enthält das Resultset ein Fortsetzungstoken zum Abrufen des nächsten Resultsets. Die einzige zuverlässige Möglichkeit, um zu ermitteln, ob keine Weiteren Dienstprinzipale mehr vorhanden sind, ist das Fehlen eines Fortsetzungstokens.

GET https://vssps.dev.azure.com/{organization}/_apis/graph/serviceprincipals?api-version=7.1-preview.1

With optional parameters:

GET https://vssps.dev.azure.com/{organization}/_apis/graph/serviceprincipals?continuationToken={continuationToken}&scopeDescriptor={scopeDescriptor}&api-version=7.1-preview.1

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
organization	path	True	string	Der Name der Azure DevOps-Organisation.
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "7.1-preview.1" festgelegt werden, um diese Version der API zu verwenden.
continuationToken	query		string	Ein undurchsichtiges Datenblob, das ermöglicht, dass die nächste Datenseite unmittelbar nach dem Ende der vorherigen Seite fortgesetzt werden kann. Die einzige zuverlässige Möglichkeit, um zu ermitteln, ob mehr Daten übrig sind, ist das Vorhandensein eines Fortsetzungstokens.
scopeDescriptor	query		string	Geben Sie einen nicht standardmäßigen Bereich (Sammlung, Projekt) an, um nach Dienstprinzipalen zu suchen.

Antworten

Name	Typ	Beschreibung
200 OK	GraphServicePrincipal[]	Erfolgreicher Vorgang Headers X-MS-ContinuationToken: string

Name

Typ

Beschreibung

200 OK

GraphServicePrincipal[]

Erfolgreicher Vorgang

Headers

X-MS-ContinuationToken: string

Sicherheit

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Name	Beschreibung
vso.graph	Ermöglicht das Lesen von Benutzer-, Gruppen-, Bereichs- und Gruppenmitgliedschaftsinformationen

Beispiele

Sample Request

HTTP

GET https://vssps.dev.azure.com/{organization}/_apis/graph/serviceprincipals?api-version=7.1-preview.1

Sample Response

Status code:: 200

{
  "count": 2,
  "value": [
    {
      "subjectKind": "servicePrincipal",
      "applicationId": "57227acc-068c-4bd0-b122-76af4ca8156d",
      "directoryAlias": "db2b37a2-4d17-4de2-b935-59d43396a001",
      "domain": "62e2ee3f-dbd4-48d8-9b85-4a3776783e13",
      "principalName": "db2b37a2-4d17-4de2-b935-59d43396a001",
      "mailAddress": null,
      "origin": "aad",
      "originId": "db2b37a2-4d17-4de2-b935-59d43396a001",
      "displayName": "ServicePrincipalDisplayName",
      "_links": {
        "self": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/ServicePrincipals/aadsp.OGY2Njg2ODQtOTAzMi03NWE2LWFiZDctMGJhMDUzYjhiNTIx"
        },
        "memberships": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Memberships/aadsp.OGY2Njg2ODQtOTAzMi03NWE2LWFiZDctMGJhMDUzYjhiNTIx"
        },
        "membershipState": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/MembershipStates/aadsp.OGY2Njg2ODQtOTAzMi03NWE2LWFiZDctMGJhMDUzYjhiNTIx"
        },
        "storageKey": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/StorageKeys/aadsp.OGY2Njg2ODQtOTAzMi03NWE2LWFiZDctMGJhMDUzYjhiNTIx"
        },
        "avatar": {
          "href": "https://dev.azure.com/Fabrikam/_apis/GraphProfile/MemberAvatars/aadsp.OGY2Njg2ODQtOTAzMi03NWE2LWFiZDctMGJhMDUzYjhiNTIx"
        }
      },
      "url": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/ServicePrincipals/aadsp.OGY2Njg2ODQtOTAzMi03NWE2LWFiZDctMGJhMDUzYjhiNTIx",
      "descriptor": "aadsp.OGY2Njg2ODQtOTAzMi03NWE2LWFiZDctMGJhMDUzYjhiNTIx"
    },
    {
      "subjectKind": "servicePrincipal",
      "applicationId": "4461fafd-3c00-43b1-9e9a-5c554405a9d3",
      "directoryAlias": "eb8f407c-9b55-4e8a-acab-7416774c5479",
      "domain": "62e2ee3f-dbd4-48d8-9b85-4a3776783e13",
      "principalName": "eb8f407c-9b55-4e8a-acab-7416774c5479",
      "mailAddress": null,
      "origin": "aad",
      "originId": "eb8f407c-9b55-4e8a-acab-7416774c5479",
      "displayName": "ServicePrincipalDispalyName2",
      "_links": {
        "self": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/ServicePrincipals/aadsp.MjBlZDFjMDktMDRhNC03NjYwLThjNjEtZWQ4ZjZhY2ZhNDE5"
        },
        "memberships": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Memberships/aadsp.MjBlZDFjMDktMDRhNC03NjYwLThjNjEtZWQ4ZjZhY2ZhNDE5"
        },
        "membershipState": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/MembershipStates/aadsp.MjBlZDFjMDktMDRhNC03NjYwLThjNjEtZWQ4ZjZhY2ZhNDE5"
        },
        "storageKey": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/StorageKeys/aadsp.MjBlZDFjMDktMDRhNC03NjYwLThjNjEtZWQ4ZjZhY2ZhNDE5"
        },
        "avatar": {
          "href": "https://dev.azure.com/Fabrikam/_apis/GraphProfile/MemberAvatars/aadsp.MjBlZDFjMDktMDRhNC03NjYwLThjNjEtZWQ4ZjZhY2ZhNDE5"
        }
      },
      "url": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/ServicePrincipals/aadsp.MjBlZDFjMDktMDRhNC03NjYwLThjNjEtZWQ4ZjZhY2ZhNDE5",
      "descriptor": "aadsp.MjBlZDFjMDktMDRhNC03NjYwLThjNjEtZWQ4ZjZhY2ZhNDE5"
    }
  ]
}

Definitionen

Name	Beschreibung
GraphServicePrincipal
ReferenceLinks	Die -Klasse, die eine Auflistung von REST-Verweislinks darstellt.

GraphServicePrincipal

Name	Typ	Beschreibung
_links	ReferenceLinks	Dieses Feld enthält null oder interessantere Links zum Graphthema. Diese Links können aufgerufen werden, um zusätzliche Beziehungen oder ausführlichere Informationen zu diesem Graphthema zu erhalten.
applicationId	string
descriptor	string	Der Deskriptor ist die primäre Methode, um auf den Graph-Betreff zu verweisen, während das System ausgeführt wird. In diesem Feld wird derselbe Graph-Betreff sowohl für Konten als auch für Organisationen eindeutig identifiziert.
directoryAlias	string	Der kurze, im Allgemeinen eindeutige Name für den Benutzer im Sicherungsverzeichnis. Für AAD-Benutzer entspricht dies dem E-Mail-Spitznamen, der oft, aber nicht unbedingt dem Teil der E-Mail-Adresse des Benutzers vor dem @-Zeichen ähnelt. Für GitHub-Benutzer entspricht dies dem GitHub-Benutzerhandle.
displayName	string	Dies ist der nicht eindeutige Anzeigename des Graph-Betreffs. Um dieses Feld zu ändern, müssen Sie dessen Wert im Quellanbieter ändern.
domain	string	Dies stellt den Namen des Ursprungscontainers für einen Graphmember dar. (Für MSA ist dies "Windows Live ID", für AD der Name der Domäne, für AAD die mandanten-ID des Verzeichnisses, für VSTS-Gruppen die ScopeId usw.)
isDeletedInOrigin	boolean	Wenn true, wurde die Gruppe im Identitätsanbieter gelöscht.
legacyDescriptor	string	[Nur interne Verwendung] Der Legacydeskriptor ist hier, falls Sie mithilfe des Identitätsdeskriptors auf IMS der alten Version zugreifen müssen.
mailAddress	string	Die E-Mail-Adresse des Datensatzes für einen bestimmten Graph-Member. Dieser kann sich vom Prinzipalnamen unterscheiden.
metaType	string	Der Metatyp des Benutzers im Ursprung, z. B. "Member", "Guest" usw. Den Satz möglicher Werte finden Sie unter UserMetaType.
origin	string	Der Typ des Quellanbieters für den Ursprungsbezeichner (z. B. AD, AAD, MSA)
originId	string	Der eindeutige Bezeichner aus dem Ursprungssystem. In der Regel eine Sid, eine Objekt-ID oder eine GUID. Verknüpfungs- und Verknüpfungsvorgänge können dazu führen, dass sich dieser Wert für einen Benutzer ändert, da der Benutzer nicht von einem anderen Anbieter unterstützt wird und im neuen Anbieter über eine andere eindeutige ID verfügt.
principalName	string	Dies ist der PrincipalName dieses Graphelements aus dem Quellanbieter. Der Quellanbieter kann dieses Feld im Laufe der Zeit ändern, und es ist nicht garantiert, dass es für die Lebensdauer des Graphelements durch VSTS unveränderlich ist.
subjectKind	string	Dieses Feld identifiziert den Typ des Graph-Betreffs (z. B. Gruppe, Bereich, Benutzer).
url	string	Diese URL ist die vollständige Route zur Quellressource dieses Graph-Betreffs.

ReferenceLinks

Die -Klasse, die eine Auflistung von REST-Verweislinks darstellt.

Name	Typ	Beschreibung
links	object	Die schreibgeschützte Ansicht der Links. Da Verweislinks schreibgeschützter Sind, möchten wir sie nur als schreibgeschützter Link verfügbar machen.

Share via