Accounts - List
Obtenga una lista de cuentas para un propietario específico o un miembro específico. Se requiere uno de los parámetros siguientes: ownerId, memberId.
GET https://app.vssps.visualstudio.com/_apis/accounts?api-version=6.0
GET https://app.vssps.visualstudio.com/_apis/accounts?ownerId={ownerId}&memberId={memberId}&properties={properties}&api-version=6.0
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
api-version
|
query | True |
string |
Versión de la API que se va a usar. Debe establecerse en "6.0" para usar esta versión de la API. |
member
|
query |
string uuid |
Identificador de un miembro de las cuentas. |
|
owner
|
query |
string uuid |
Identificador del propietario de las cuentas. |
|
properties
|
query |
string |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Account[] |
operación correcta |
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.profile | Concede la capacidad de leer el perfil, las cuentas, las colecciones, los proyectos, los equipos y otros artefactos de la organización de nivel superior. |
Ejemplos
By member |
By owner |
By member
Sample Request
GET https://app.vssps.visualstudio.com/_apis/accounts?memberId=d6245f20-2af8-44f4-9451-8107cb2767db&api-version=6.0
Sample Response
{
"count": 2,
"value": [
{
"accountId": "6affcbef-fe5d-44c6-8a29-439b79aaa118",
"accountUri": "https://vssps.dev.azure.com/Fabrikam-Fiber-Inc/",
"accountName": "Fabrikam-Fiber-Inc",
"properties": {}
},
{
"accountId": "bf83696f-383b-4980-95b5-1f1127640a8a",
"accountUri": "https://vssps.dev.azure.com/NormalPaulk/",
"accountName": "NormalPaulk",
"properties": {}
}
]
}
By owner
Sample Request
GET https://app.vssps.visualstudio.com/_apis/accounts?ownerId=d6245f20-2af8-44f4-9451-8107cb2767db&api-version=6.0
Sample Response
{
"count": 1,
"value": [
{
"accountId": "bf83696f-383b-4980-95b5-1f1127640a8a",
"accountUri": "https://NormalPaulk.vssps.visualstudio.com:443/",
"accountName": "NormalPaulk",
"properties": {}
}
]
}
Definiciones
Nombre | Description |
---|---|
Account | |
Account |
Estado de la cuenta actual |
Account |
Tipo de cuenta: Personal, Organización |
Properties |
La clase representa un contenedor de propiedades como una colección de pares clave-valor. Se aceptan valores de todos los tipos primitivos (cualquier tipo con un |
Account
Nombre | Tipo | Description |
---|---|---|
accountId |
string |
Identificador de una cuenta |
accountName |
string |
Nombre de una cuenta |
accountOwner |
string |
Propietario de la cuenta |
accountStatus |
Estado de la cuenta actual |
|
accountType |
Tipo de cuenta: Personal, Organización |
|
accountUri |
string |
Uri de una cuenta |
createdBy |
string |
Quién creó la cuenta |
createdDate |
string |
Fecha de creación de la cuenta |
hasMoved |
boolean |
|
lastUpdatedBy |
string |
Identidad de la última persona para actualizar la cuenta |
lastUpdatedDate |
string |
Fecha en que se actualizó por última vez la cuenta |
namespaceId |
string |
Espacio de nombres para una cuenta |
newCollectionId |
string |
|
organizationName |
string |
Organización que creó la cuenta |
properties |
Propiedades extendidas |
|
statusReason |
string |
Motivo del estado actual |
AccountStatus
Estado de la cuenta actual
Nombre | Tipo | Description |
---|---|---|
deleted |
string |
Esta cuenta forma parte del lote de eliminación y está programada para su eliminación. |
disabled |
string |
Esta cuenta de hospedaje está deshabilitada. |
enabled |
string |
Esta cuenta de hospedaje está activa y asignada a un cliente. |
moved |
string |
Esta cuenta no está maestra localmente y se ha movido físicamente. |
none |
string |
AccountType
Tipo de cuenta: Personal, Organización
Nombre | Tipo | Description |
---|---|---|
organization |
string |
|
personal |
string |
PropertiesCollection
La clase representa un contenedor de propiedades como una colección de pares clave-valor. Se aceptan valores de todos los tipos primitivos (cualquier tipo con un TypeCode != TypeCode.Object
) excepto DBNull
. Los valores de tipo Byte[], Int32, Double, DateType y String conservan su tipo; otros primitivos se vuelven a ajustar como string. Byte[] se esperaba como cadena codificada en base64.
Nombre | Tipo | Description |
---|---|---|
count |
integer |
Recuento de propiedades de la colección. |
item |
object |
|
keys |
string[] |
Conjunto de claves de la colección. |
values |
string[] |
Conjunto de valores de la colección. |
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