Condividi tramite


Service Principals - List

Ottenere un elenco di tutte le entità servizio in un determinato ambito.

Poiché l'elenco delle entità servizio può essere di grandi dimensioni, i risultati vengono restituiti in pagine di entità servizio. Se sono presenti più risultati di quanti possano essere restituiti in una singola pagina, il set di risultati conterrà un token di continuazione per il recupero del set di risultati successivo. L'unico modo affidabile per sapere se non ci sono più entità servizio lasciate è la mancanza di un token di continuazione.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
organization
path True

string

Nome dell'organizzazione di Azure DevOps.

api-version
query True

string

Versione dell'API da usare. Deve essere impostato su '7.1-preview.1' per usare questa versione dell'API.

continuationToken
query

string

BLOB di dati opaco che consente alla pagina successiva di dati di riprendere immediatamente dopo la fine della pagina precedente. L'unico modo affidabile per sapere se sono presenti più dati è la presenza di un token di continuazione.

scopeDescriptor
query

string

Specificare un ambito non predefinito (raccolta, progetto) per la ricerca di entità servizio.

Risposte

Nome Tipo Descrizione
200 OK

GraphServicePrincipal[]

operazione riuscita

Headers

X-MS-ContinuationToken: string

Sicurezza

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

Nome Descrizione
vso.graph Concede la possibilità di leggere informazioni su utente, gruppo, ambito e appartenenza a gruppi

Esempio

Sample Request

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

Sample Response

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

Definizioni

Nome Descrizione
GraphServicePrincipal
ReferenceLinks

Classe per rappresentare una raccolta di collegamenti di riferimento REST.

GraphServicePrincipal

Nome Tipo Descrizione
_links

ReferenceLinks

Questo campo contiene zero o più collegamenti interessanti sull'oggetto del grafico. Questi collegamenti possono essere richiamati per ottenere relazioni aggiuntive o informazioni più dettagliate su questo oggetto grafico.

applicationId

string

descriptor

string

Il descrittore è il modo principale per fare riferimento all'oggetto del grafo mentre il sistema è in esecuzione. Questo campo identificherà in modo univoco lo stesso oggetto grafico in account e organizzazioni.

directoryAlias

string

Nome breve, in genere univoco per l'utente nella directory di backup. Per gli utenti di AAD, corrisponde al nome alternativo di posta elettronica, che è spesso ma non necessariamente simile alla parte dell'indirizzo di posta dell'utente prima del segno @. Per gli utenti di GitHub, corrisponde all'handle utente di GitHub.

displayName

string

Si tratta del nome visualizzato non univoco dell'oggetto del grafico. Per modificare questo campo, è necessario modificarne il valore nel provider di origine.

domain

string

Rappresenta il nome del contenitore di origine per un membro del grafo. Per msa si tratta di "Windows Live ID", per AD il nome del dominio, per AAD il tenantID della directory, per VSTS raggruppa scopeId e così via.

isDeletedInOrigin

boolean

Se true, il gruppo è stato eliminato nel provider di identità

legacyDescriptor

string

[Solo utilizzo interno] Il descrittore legacy è qui nel caso in cui sia necessario accedere alla versione precedente di IMS usando il descrittore di identità.

mailAddress

string

Indirizzo di posta elettronica del record per un determinato membro del grafo. Può essere diverso dal nome dell'entità.

metaType

string

Metatipo dell'utente nell'origine, ad esempio "membro", "guest" e così via. Vedere UserMetaType per il set di valori possibili.

origin

string

Tipo di provider di origine per l'identificatore di origine (ad esempio, AD, AAD, MSA)

originId

string

Identificatore univoco del sistema di origine. In genere un sid, un ID oggetto o un GUID. Il collegamento e l'scollegamento delle operazioni possono causare la modifica di questo valore per un utente perché l'utente non è supportato da un provider diverso e ha un ID univoco diverso nel nuovo provider.

principalName

string

Questo è il PrincipalName di questo membro del grafo dal provider di origine. Il provider di origine può modificare questo campo nel tempo e non è garantito che non sia modificabile per la durata del membro del grafo da VSTS.

subjectKind

string

Questo campo identifica il tipo di oggetto del grafo ,ad esempio Gruppo, Ambito, Utente.

url

string

Questo URL è la route completa alla risorsa di origine di questo oggetto grafico.

Classe per rappresentare una raccolta di collegamenti di riferimento REST.

Nome Tipo Descrizione
links

object

Visualizzazione di sola lettura dei collegamenti. Poiché i collegamenti di riferimento sono di sola lettura, è consigliabile esporli solo come di sola lettura.