Partager via


Service Principals - Get

Obtenir un principal de service par son descripteur.

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

Paramètres URI

Nom Dans Obligatoire Type Description
organization
path True

string

Nom de l’organisation Azure DevOps.

servicePrincipalDescriptor
path True

string

Descripteur du principal de service souhaité.

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.

Réponses

Nom Type Description
200 OK

GraphServicePrincipal

opération réussie

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

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

Sample Response

{
  "subjectKind": "servicePrincipal",
  "applicationId": "4096aded-4444-4444-9ad0-b25b6b2a2bbe",
  "directoryAlias": "f632cdfd-4444-4444-99ce-6fe0fd007d9d",
  "domain": "62e2ee3f-4444-4444-9b85-4a3776783e13",
  "principalName": "f632cdfd-4444-4444-99ce-6fe0fd007d9d",
  "mailAddress": null,
  "origin": "aad",
  "originId": "f632cdfd-4444-4444-99ce-6fe0fd007d9d",
  "displayName": "ServicePrincipalDisplayName",
  "_links": {
    "self": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/ServicePrincipals/aadsp.OTE2ZTY1NmItYTBiNS03ZjNmLTg0YWEtNGViMTVhZjc4ZTYz"
    },
    "memberships": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Memberships/aadsp.OTE2ZTY1NmItYTBiNS03ZjNmLTg0YWEtNGViMTVhZjc4ZTYz"
    },
    "membershipState": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/MembershipStates/aadsp.OTE2ZTY1NmItYTBiNS03ZjNmLTg0YWEtNGViMTVhZjc4ZTYz"
    },
    "storageKey": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/StorageKeys/aadsp.OTE2ZTY1NmItYTBiNS03ZjNmLTg0YWEtNGViMTVhZjc4ZTYz"
    },
    "avatar": {
      "href": "https://dev.azure.com/Fabrikam/_apis/GraphProfile/MemberAvatars/aadsp.OTE2ZTY1NmItYTBiNS03ZjNmLTg0YWEtNGViMTVhZjc4ZTYz"
    }
  },
  "url": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/ServicePrincipals/aadsp.OTE2ZTY1NmItYTBiNS03ZjNmLTg0YWEtNGViMTVhZjc4ZTYz",
  "descriptor": "aadsp.OTE2ZTY1NmItYTBiNS03ZjNmLTg0YWEtNGViMTVhZjc4ZTYz"
}

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.

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.