Service Principals - List

Référence

Service:: Graph

API Version:: 7.1-preview.1

Obtenez la liste de tous les principaux de service dans une étendue donnée.

Étant donné que la liste des principaux de service peut être volumineuse, les résultats sont retournés dans les pages des principaux de service. S’il y a plus de résultats que peut être retourné dans une seule page, le jeu de résultats contient un jeton de continuation pour la récupération du jeu de résultats suivant. La seule façon fiable de savoir s’il n’y a plus de principaux de service est l’absence d’un jeton de continuation.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
organization	path	True	string	Nom de l’organisation Azure DevOps.
api-version	query	True	string	Version de l’API à utiliser. Cette valeur doit être définie sur « 7.1-preview.1 » pour utiliser cette version de l’API.
continuationToken	query		string	Objet blob de données opaque qui permet à la page suivante de reprendre immédiatement après la fin de la page précédente. La seule façon fiable de savoir s’il reste plus de données est la présence d’un jeton de continuation.
scopeDescriptor	query		string	Spécifiez une étendue non définie par défaut (collection, projet) pour rechercher des principaux de service.

Réponses

Nom	Type	Description
200 OK	GraphServicePrincipal[]	opération réussie Headers X-MS-ContinuationToken: string

Nom

Type

Description

200 OK

GraphServicePrincipal[]

opération réussie

Headers

X-MS-ContinuationToken: string

Sécurité

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

Nom	Description
vso.graph	Accorde la possibilité de lire les informations d’utilisateur, de groupe, d’étendue et d’appartenance au groupe

Exemples

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

Définitions

Nom	Description
GraphServicePrincipal
ReferenceLinks	Classe pour représenter une collection de liens de référence REST.

GraphServicePrincipal

Nom	Type	Description
_links	ReferenceLinks	Ce champ contient zéro ou plus de liens intéressants sur l’objet du graphique. Ces liens peuvent être appelés pour obtenir des relations supplémentaires ou des informations plus détaillées sur ce sujet de graphique.
applicationId	string
descriptor	string	Le descripteur est le principal moyen de référencer l’objet du graphique pendant l’exécution du système. Ce champ identifie de manière unique le même sujet de graphique dans les comptes et les organisations.
directoryAlias	string	Nom court et généralement unique de l’utilisateur dans le répertoire de stockage. Pour les utilisateurs AAD, cela correspond au surnom du courrier, qui est souvent mais pas nécessairement similaire à la partie de l’adresse de messagerie de l’utilisateur avant le signe @ . Pour les utilisateurs GitHub, cela correspond au handle utilisateur GitHub.
displayName	string	Il s’agit du nom d’affichage non unique de l’objet du graphique. Pour modifier ce champ, vous devez modifier sa valeur dans le fournisseur source.
domain	string	Représente le nom du conteneur d’origine pour un membre de graphique. (Pour MSA, il s’agit de « Windows Live ID », pour AD le nom du domaine, pour AAD le tenantID du répertoire, pour les groupes VSTS l’ScopeId, etc.)
isDeletedInOrigin	boolean	Lorsque la valeur est true, le groupe a été supprimé dans le fournisseur d’identité
legacyDescriptor	string	[Usage interne uniquement] Le descripteur hérité est ici au cas où vous deviez accéder à l’ancienne version d’IMS à l’aide du descripteur d’identité.
mailAddress	string	Adresse e-mail de l’enregistrement d’un membre de graphique donné. Il peut être différent du nom du principal.
metaType	string	Type de méta de l’utilisateur dans l’origine, tel que « membre », « invité », etc. Consultez UserMetaType pour connaître l’ensemble des valeurs possibles.
origin	string	Type de fournisseur source pour l’identificateur d’origine (ex:AD, AAD, MSA)
originId	string	Identificateur unique du système d’origine. Généralement un sid, un ID d’objet ou un GUID. Les opérations de liaison et de dissociation peuvent entraîner la modification de cette valeur pour un utilisateur, car l’utilisateur n’est pas soutenu par un autre fournisseur et a un ID unique différent dans le nouveau fournisseur.
principalName	string	Il s’agit du principalName de ce membre de graphe du fournisseur source. Le fournisseur source peut modifier ce champ au fil du temps et il n’est pas garanti qu’il soit immuable pendant la durée de vie du membre de graphique par VSTS.
subjectKind	string	Ce champ identifie le type de l’objet du graphique (par exemple, groupe, étendue, utilisateur).
url	string	Cette URL est l’itinéraire complet vers la ressource source de ce sujet de graphique.

ReferenceLinks

Classe pour représenter une collection de liens de référence REST.

Nom	Type	Description
links	object	Vue en lecture seule des liens. Étant donné que les liens référence sont en lecture seule, nous voulons uniquement les exposer en lecture seule.

Partager via