Service Principals - List

Referência

Service:: Graph

API Version:: 7.1-preview.1

Obtenha uma lista de todas as entidades de serviço em um determinado escopo.

Como a lista de entidades de serviço pode ser grande, os resultados são retornados em páginas de entidades de serviço. Se houver mais resultados do que podem ser retornados em uma única página, o conjunto de resultados conterá um token de continuação para recuperação do próximo conjunto de resultados. A única maneira confiável de saber se não há mais entidades de serviço restantes é a falta de um token de continuação.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
organization	path	True	string	O nome da organização do Azure DevOps.
api-version	query	True	string	Versão da API a ser usada. Isso deve ser definido como '7.1-preview.1' para usar essa versão da API.
continuationToken	query		string	Um blob de dados opaco que permite que a próxima página de dados seja retomada imediatamente após o término da página anterior. A única maneira confiável de saber se há mais dados restantes é a presença de um token de continuação.
scopeDescriptor	query		string	Especifique um escopo não padrão (coleção, projeto) para pesquisar entidades de serviço.

Respostas

Nome	Tipo	Description
200 OK	GraphServicePrincipal[]	operação bem-sucedida Headers X-MS-ContinuationToken: string

Nome

Tipo

Description

200 OK

GraphServicePrincipal[]

operação bem-sucedida

Headers

X-MS-ContinuationToken: string

Segurança

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	Description
vso.graph	Concede a capacidade de ler informações de usuário, grupo, escopo e associação de grupo

Exemplos

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

Definições

Nome	Description
GraphServicePrincipal
ReferenceLinks	A classe para representar uma coleção de links de referência REST.

GraphServicePrincipal

Nome	Tipo	Description
_links	ReferenceLinks	Esse campo contém zero ou mais links interessantes sobre o assunto do grafo. Esses links podem ser invocados para obter relações adicionais ou informações mais detalhadas sobre esse assunto do grafo.
applicationId	string
descriptor	string	O descritor é a principal maneira de referenciar o assunto do grafo enquanto o sistema está em execução. Esse campo identificará exclusivamente o mesmo assunto do grafo entre contas e organizações.
directoryAlias	string	O nome curto e geralmente exclusivo para o usuário no diretório de suporte. Para usuários do AAD, isso corresponde ao apelido de email, que geralmente é, mas não necessariamente semelhante à parte do endereço de email do usuário antes do sinal @ . Para usuários do GitHub, isso corresponde ao identificador de usuário do GitHub.
displayName	string	Este é o nome de exibição não exclusivo do assunto do grafo. Para alterar esse campo, você deve alterar seu valor no provedor de origem.
domain	string	Isso representa o nome do contêiner de origem de um membro do grafo. (Para MSA, essa é a "ID do Windows Live", para o AD o nome do domínio, para o AAD a tenantID do diretório, para grupos de VSTS, ScopeId etc.
isDeletedInOrigin	boolean	Quando true, o grupo foi excluído no provedor de identidade
legacyDescriptor	string	[Somente uso interno] O descritor herdado está aqui caso você precise acessar o IMS da versão antiga usando o descritor de identidade.
mailAddress	string	O endereço de email do registro de um determinado membro do grafo. Isso pode ser diferente do nome da entidade de segurança.
metaType	string	O meta tipo do usuário na origem, como "membro", "convidado", etc. Consulte UserMetaType para obter o conjunto de valores possíveis.
origin	string	O tipo de provedor de origem para o identificador de origem (ex:AD, AAD, MSA)
originId	string	O identificador exclusivo do sistema de origem. Normalmente, um sid, id de objeto ou Guid. As operações de vinculação e desvinculação podem fazer com que esse valor seja alterado para um usuário porque o usuário não tem suporte de um provedor diferente e tem uma ID exclusiva diferente no novo provedor.
principalName	string	Este é o PrincipalName desse membro de grafo do provedor de origem. O provedor de origem pode alterar esse campo ao longo do tempo e não é garantido que ele seja imutável durante a vida útil do membro do grafo pelo VSTS.
subjectKind	string	Esse campo identifica o tipo da entidade do grafo (por exemplo: Grupo, Escopo, Usuário).
url	string	Essa URL é a rota completa para o recurso de origem desta entidade de grafo.

ReferenceLinks

A classe para representar uma coleção de links de referência REST.

Nome	Tipo	Description
links	object	A exibição somente leitura dos links. Como os links de referência são somente leitura, só queremos expô-los como somente leitura.

Compartilhar via