Service Principals - List
Obtenga una lista de todas las entidades de servicio en un ámbito determinado.
Dado que la lista de entidades de servicio puede ser grande, los resultados se devuelven en páginas de entidades de servicio. Si hay más resultados de los que se pueden devolver en una sola página, el conjunto de resultados contendrá un token de continuación para la recuperación del siguiente conjunto de resultados. La única manera confiable de saber si no quedan más entidades de servicio es la falta de un token de continuación.
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
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
organization
|
path | True |
string |
El nombre de la organización de Azure DevOps. |
api-version
|
query | True |
string |
Versión de la API que se va a usar. Debe establecerse en "7.1-preview.1" para usar esta versión de la API. |
continuation
|
query |
string |
Un blob de datos opaco que permite que la página siguiente de datos se reanude inmediatamente después de la finalización de la página anterior. La única manera confiable de saber si hay más datos a la izquierda es la presencia de un token de continuación. |
|
scope
|
query |
string |
Especifique un ámbito no predeterminado (colección, proyecto) para buscar entidades de servicio. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
operación correcta Headers X-MS-ContinuationToken: string |
Seguridad
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
Nombre | Description |
---|---|
vso.graph | Concede la capacidad de leer información de usuario, grupo, ámbito y pertenencia a grupos. |
Ejemplos
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"
}
]
}
Definiciones
Nombre | Description |
---|---|
Graph |
|
Reference |
Clase que se va a representar una colección de vínculos de referencia de REST. |
GraphServicePrincipal
Nombre | Tipo | Description |
---|---|---|
_links |
Este campo contiene cero o más vínculos interesantes sobre el tema del grafo. Estos vínculos se pueden invocar para obtener relaciones adicionales o información más detallada sobre este tema del grafo. |
|
applicationId |
string |
|
descriptor |
string |
El descriptor es la forma principal de hacer referencia al asunto del grafo mientras se ejecuta el sistema. Este campo identificará de forma única el mismo asunto del grafo en cuentas y organizaciones. |
directoryAlias |
string |
Nombre corto, generalmente único para el usuario en el directorio de respaldo. Para los usuarios de AAD, esto corresponde al alias de correo, que suele ser similar a la parte de la dirección de correo del usuario antes del signo @ . Para los usuarios de GitHub, esto corresponde al identificador de usuario de GitHub. |
displayName |
string |
Este es el nombre para mostrar no único del asunto del grafo. Para cambiar este campo, debe modificar su valor en el proveedor de origen. |
domain |
string |
Representa el nombre del contenedor de origen para un miembro de grafo. (Para MSA, este es "Windows Live ID", para AD el nombre del dominio, para AAD el tenantID del directorio, para los grupos de VSTS ScopeId, etc.) |
isDeletedInOrigin |
boolean |
Cuando es true, el grupo se ha eliminado en el proveedor de identidades. |
legacyDescriptor |
string |
[Solo uso interno] El descriptor heredado está aquí en caso de que tenga que acceder a la versión anterior de IMS mediante el descriptor de identidad. |
mailAddress |
string |
Dirección de correo electrónico del registro de un miembro de grafo determinado. Puede ser diferente del nombre principal. |
metaType |
string |
Meta type del usuario en el origen, como "member", "guest", etc. Consulte UserMetaType para obtener el conjunto de valores posibles. |
origin |
string |
Tipo de proveedor de origen para el identificador de origen (por ejemplo: AD, AAD, MSA) |
originId |
string |
Identificador único del sistema de origen. Normalmente, un sid, un identificador de objeto o un GUID. Las operaciones de vinculación y desvinculación pueden hacer que este valor cambie para un usuario porque el usuario no está respaldado por un proveedor diferente y tiene un identificador único diferente en el nuevo proveedor. |
principalName |
string |
Este es el nombre principal de este miembro del grafo del proveedor de origen. El proveedor de origen puede cambiar este campo a lo largo del tiempo y no se garantiza que sea inmutable durante la vida del miembro del grafo por VSTS. |
subjectKind |
string |
Este campo identifica el tipo del asunto del grafo (por ejemplo, Grupo, Ámbito, Usuario). |
url |
string |
Esta dirección URL es la ruta completa al recurso de origen de este tema del grafo. |
ReferenceLinks
Clase que se va a representar una colección de vínculos de referencia de REST.
Nombre | Tipo | Description |
---|---|---|
links |
object |
Vista de lectura de los vínculos. Dado que los vínculos de referencia son de solo lectura, solo queremos exponerlos como de solo lectura. |
Comentarios
https://aka.ms/ContentUserFeedback.
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea:Enviar y ver comentarios de