Freigeben über


Users - Get

Rufen Sie einen Benutzer anhand seines Deskriptors ab.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
organization
path True

string

Der Name der Azure DevOps-Organisation.

userDescriptor
path True

string

Der Deskriptor des gewünschten Benutzers.

api-version
query True

string

Version der zu verwendenden API. Dies sollte auf "7.1-preview.1" festgelegt werden, um diese Version der API zu verwenden.

Antworten

Name Typ Beschreibung
200 OK

GraphUser

Erfolgreicher Vorgang

Sicherheit

oauth2

Typ: oauth2
Ablauf: accessCode
Autorisierungs-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

Bereiche

Name Beschreibung
vso.graph Gewährt die Möglichkeit, Benutzer-, Gruppen-, Bereichs- und Gruppenmitgliedschaftsinformationen zu lesen.

Beispiele

Beispielanforderung

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

Beispiel für eine Antwort

{
  "subjectKind": "user",
  "domain": "45aa3d2d-7442-473d-b4d3-3c670da9dd96",
  "principalName": "jtseng@vscsi.us",
  "mailAddress": "jtseng@vscsi.us",
  "origin": "aad",
  "originId": "55c8c7b6-7ace-43bc-918f-304dfa2b6317",
  "displayName": "Jia-hao Tseng",
  "_links": {
    "self": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Users/aad.MDA0NzBlMzQtZGE2MS03YTY5LWJkOTYtNDg3YTg0OWVjNTU4"
    },
    "memberships": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Memberships/aad.MDA0NzBlMzQtZGE2MS03YTY5LWJkOTYtNDg3YTg0OWVjNTU4"
    },
    "membershipState": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/MembershipStates/aad.MDA0NzBlMzQtZGE2MS03YTY5LWJkOTYtNDg3YTg0OWVjNTU4"
    },
    "storageKey": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/StorageKeys/aad.MDA0NzBlMzQtZGE2MS03YTY5LWJkOTYtNDg3YTg0OWVjNTU4"
    },
    "avatar": {
      "href": "https://dev.azure.com/Fabrikam/_apis/GraphProfile/MemberAvatars/aad.MDA0NzBlMzQtZGE2MS03YTY5LWJkOTYtNDg3YTg0OWVjNTU4"
    }
  },
  "url": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Users/aad.MDA0NzBlMzQtZGE2MS03YTY5LWJkOTYtNDg3YTg0OWVjNTU4",
  "descriptor": "aad.MDA0NzBlMzQtZGE2MS03YTY5LWJkOTYtNDg3YTg0OWVjNTU4"
}

Definitionen

Name Beschreibung
GraphUser
ReferenceLinks

Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.

GraphUser

Name Typ Beschreibung
_links

ReferenceLinks

Dieses Feld enthält null oder interessantere Links zum Thema Diagramm. Diese Links können aufgerufen werden, um zusätzliche Beziehungen oder ausführlichere Informationen zu diesem Diagrammbetreff zu erhalten.

descriptor

string

Der Deskriptor ist die primäre Möglichkeit, auf den Diagrammbetreff zu verweisen, während das System ausgeführt wird. In diesem Feld wird dasselbe Diagrammthema sowohl in Firmen als auch in Organisationen eindeutig identifiziert.

directoryAlias

string

Der kurze, im Allgemeinen eindeutige Name für den Benutzer im Sicherungsverzeichnis. Bei AAD-Benutzern entspricht dies dem E-Mail-Spitznamen, der häufig, aber nicht unbedingt dem Teil der E-Mail-Adresse des Benutzers vor dem @-Zeichen ähnelt. Für GitHub-Benutzer entspricht dies dem GitHub-Benutzerhandle.

displayName

string

Dies ist der nicht eindeutige Anzeigename des Diagrammbetreffs. Um dieses Feld zu ändern, müssen Sie den Wert im Quellanbieter ändern.

domain

string

Dies stellt den Namen des Ursprungscontainers für ein Graph-Element dar. (Für MSA lautet dies "Windows Live ID", für AD den Namen der Domäne, für AAD die Mandanten-ID des Verzeichnisses, für VSTS-Gruppen die ScopeId usw.)

isDeletedInOrigin

boolean

Wenn "true" ist, wurde die Gruppe im Identitätsanbieter gelöscht.

legacyDescriptor

string

[Nur interne Verwendung] Der Legacydeskriptor ist hier, falls Sie mithilfe des Identitätsdeskriptors auf alte Version IMS zugreifen müssen.

mailAddress

string

Die E-Mail-Adresse des Datensatzes für ein bestimmtes Graph-Element. Dies kann sich von dem Prinzipalnamen unterscheiden.

metaType

string

Der Metatyp des Benutzers im Ursprung, z. B. "Mitglied", "Gast" usw. Informationen zum Satz möglicher Werte finden Sie unter UserMetaType.

origin

string

Der Typ des Quellanbieters für den Ursprungsbezeichner (ex:AD, AAD, MSA)

originId

string

Der eindeutige Bezeichner aus dem Ursprungssystem. In der Regel eine SID, Objekt-ID oder GUID. Verknüpfungs- und Verknüpfungsvorgänge können dazu führen, dass sich dieser Wert für einen Benutzer ändert, da der Benutzer nicht von einem anderen Anbieter unterstützt wird und eine andere eindeutige ID im neuen Anbieter aufweist.

principalName

string

Dies ist der PrincipalName dieses Graph-Elements vom Quellanbieter. Der Quellanbieter kann dieses Feld im Laufe der Zeit ändern und ist nicht garantiert unveränderlich für die Lebensdauer des Graph-Elements durch VSTS.

subjectKind

string

Dieses Feld identifiziert den Typ des Diagrammbetreffs (z. B. Gruppe, Bereich, Benutzer).

url

string

Diese URL ist die vollständige Route zur Quellressource dieses Graph-Betreffs.

Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.

Name Typ Beschreibung
links

object

Die schreibgeschützte Ansicht der Links. Da Referenzlinks schreibgeschützt sind, möchten wir sie nur als schreibgeschützt verfügbar machen.