Service Principals - Get

Získejte instanční objekt podle jeho popisovače.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
organization
path True

string

Název organizace Azure DevOps.

servicePrincipalDescriptor
path True

string

Popisovač požadovaného instančního objektu.

api-version
query True

string

Verze rozhraní API, která se má použít. Tato verze rozhraní API by měla být nastavená na 7.1-preview.1.

Odpovědi

Name Typ Description
200 OK

GraphServicePrincipal

úspěšná operace

Zabezpečení

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

Name Description
vso.graph Uděluje možnost číst informace o uživateli, skupině, oboru a členství ve skupinách.

Příklady

Sample Request

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

Sample Response

{
  "subjectKind": "servicePrincipal",
  "applicationId": "4096aded-4444-4444-9ad0-b25b6b2a2bbe",
  "directoryAlias": "f632cdfd-4444-4444-99ce-6fe0fd007d9d",
  "domain": "62e2ee3f-4444-4444-9b85-4a3776783e13",
  "principalName": "f632cdfd-4444-4444-99ce-6fe0fd007d9d",
  "mailAddress": null,
  "origin": "aad",
  "originId": "f632cdfd-4444-4444-99ce-6fe0fd007d9d",
  "displayName": "ServicePrincipalDisplayName",
  "_links": {
    "self": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/ServicePrincipals/aadsp.OTE2ZTY1NmItYTBiNS03ZjNmLTg0YWEtNGViMTVhZjc4ZTYz"
    },
    "memberships": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Memberships/aadsp.OTE2ZTY1NmItYTBiNS03ZjNmLTg0YWEtNGViMTVhZjc4ZTYz"
    },
    "membershipState": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/MembershipStates/aadsp.OTE2ZTY1NmItYTBiNS03ZjNmLTg0YWEtNGViMTVhZjc4ZTYz"
    },
    "storageKey": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/StorageKeys/aadsp.OTE2ZTY1NmItYTBiNS03ZjNmLTg0YWEtNGViMTVhZjc4ZTYz"
    },
    "avatar": {
      "href": "https://dev.azure.com/Fabrikam/_apis/GraphProfile/MemberAvatars/aadsp.OTE2ZTY1NmItYTBiNS03ZjNmLTg0YWEtNGViMTVhZjc4ZTYz"
    }
  },
  "url": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/ServicePrincipals/aadsp.OTE2ZTY1NmItYTBiNS03ZjNmLTg0YWEtNGViMTVhZjc4ZTYz",
  "descriptor": "aadsp.OTE2ZTY1NmItYTBiNS03ZjNmLTg0YWEtNGViMTVhZjc4ZTYz"
}

Definice

Name Description
GraphServicePrincipal
ReferenceLinks

Třída představující kolekci odkazů REST.

GraphServicePrincipal

Name Typ Description
_links

ReferenceLinks

Toto pole neobsahuje žádný nebo více zajímavých odkazů na téma grafu. Tyto odkazy mohou být vyvolány za účelem získání dalších relací nebo podrobnějších informací o tomto předmětu grafu.

applicationId

string

descriptor

string

Popisovač je primárním způsobem, jak odkazovat na předmět grafu, když je systém spuštěný. Toto pole jednoznačně identifikuje stejný předmět grafu v rámci účtů i organizací.

directoryAlias

string

Krátký, obecně jedinečný název pro uživatele v záložním adresáři. U uživatelů AAD to odpovídá poštovní přezdívkě, která se často, ale nemusí nutně podobat části e-mailové adresy uživatele před znakem @ . U uživatelů GitHubu to odpovídá popisovači uživatele GitHubu.

displayName

string

Toto je jedinečný zobrazovaný název předmětu grafu. Chcete-li toto pole změnit, musíte změnit jeho hodnotu ve zdrojovém poskytovateli.

domain

string

Představuje název kontejneru původu pro člena grafu. (Pro MSA je to Windows Live ID, pro AD název domény, pro AAD ID tenanta adresáře, pro skupiny VSTS ScopeId atd.)

isDeletedInOrigin

boolean

Pokud je hodnota true, skupina se ve zprostředkovateli identity odstranila.

legacyDescriptor

string

[Pouze pro interní použití] Starší popisovač je tu pro případ, že ke starší verzi IMS potřebujete získat přístup pomocí popisovače identity.

mailAddress

string

E-mailová adresa záznamu pro daného člena grafu Může se lišit od hlavního názvu objektu zabezpečení.

metaType

string

Metatyp uživatele v původu, například "member", "guest" atd. Sadu možných hodnot najdete v tématu UserMetaType.

origin

string

Typ poskytovatele zdroje pro identifikátor původu (např.: AD, AAD, MSA)

originId

string

Jedinečný identifikátor ze systému původu. Obvykle identifikátor sid, ID objektu nebo identifikátor GUID. Operace propojení a zrušení propojení můžou způsobit změnu této hodnoty pro uživatele, protože uživatel není podporovaný jiným poskytovatelem a má v novém zprostředkovateli jiné jedinečné ID.

principalName

string

Toto je PrincipalName tohoto člena grafu od zdrojového poskytovatele. Zprostředkovatel zdroje může toto pole v průběhu času měnit a není zaručeno, že bude neměnné po celou dobu životnosti člena grafu službou VSTS.

subjectKind

string

Toto pole identifikuje typ předmětu grafu (např. Skupina, Obor, Uživatel).

url

string

Tato adresa URL představuje úplnou trasu ke zdrojovému prostředku tohoto předmětu grafu.

Třída představující kolekci odkazů REST.

Name Typ Description
links

object

Zobrazení odkazů jen pro čtení. Odkazy jsou jen pro čtení, a proto je chceme zveřejnit jen jako odkazy jen pro čtení.