Descriptors - Get

Reference

Service:: Graph

API Version:: 6.0-preview.1

Resolve a storage key to a descriptor

GET https://vssps.dev.azure.com/{organization}/_apis/graph/descriptors/{storageKey}?api-version=6.0-preview.1

URI Parameters

Name	In	Required	Type	Description
storageKey	path	True	string uuid	Storage key of the subject (user, group, scope, etc.) to resolve
organization	path		string	The name of the Azure DevOps organization.
api-version	query	True	string	Version of the API to use. This should be set to '6.0-preview.1' to use this version of the api.

Responses

Name	Type	Description
200 OK	GraphDescriptorResult	successful operation

Security

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	Grants the ability to read user, group, scope and group membership information

Examples

Sample Request

HTTP

GET https://vssps.dev.azure.com/_apis/graph/descriptors/{storageKey}?api-version=6.0-preview.1

Sample Response

Status code:: 200

{
  "value": "aad.OWI3MWYyMTYtNGM0Zi03Yjc0LWE5MTEtZWZiMGZhOWM3Nzdm",
  "_links": {
    "self": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Descriptors/9b71f216-4c4f-6b74-a911-efb0fa9c777f"
    },
    "storageKey": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/StorageKeys/aad.OWI3MWYyMTYtNGM0Zi03Yjc0LWE5MTEtZWZiMGZhOWM3Nzdm"
    },
    "subject": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Users/aad.OWI3MWYyMTYtNGM0Zi03Yjc0LWE5MTEtZWZiMGZhOWM3Nzdm"
    }
  }
}

Definitions

Name	Description
GraphDescriptorResult	Subject descriptor of a Graph entity
ReferenceLinks	The class to represent a collection of REST reference links.

GraphDescriptorResult

Subject descriptor of a Graph entity

Name	Type	Description
_links	ReferenceLinks	This field contains zero or more interesting links about the graph descriptor. These links may be invoked to obtain additional relationships or more detailed information about this graph descriptor.
value	string

ReferenceLinks

The class to represent a collection of REST reference links.

Name	Type	Description
links	object	The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.

Share via