Share via

Subject Query - Query

  • Reference
Service:
Graph
API Version:
7.0-preview.1

Search for Azure Devops users, or/and groups. Results will be returned in a batch with no more than 100 graph subjects.

POST https://vssps.dev.azure.com/{organization}/_apis/graph/subjectquery?api-version=7.0-preview.1

URI Parameters

Name In Required Type Description
organization
 path True

string

The name of the Azure DevOps organization.
api-version
 query True

string

Version of the API to use. This should be set to '7.0-preview.1' to use this version of the api.

Request Body

Name Type Description
query

string

Search term to search for Azure Devops users or/and groups
scopeDescriptor

string

Optional parameter. Specify a non-default scope (collection, project) to search for users or groups within the scope.
subjectKind

string[]

"User" or "Group" can be specified, both or either

Responses

Name Type Description
200 OK

GraphSubject[]

successful operation

Security

accessToken

Personal access token. Use any value for the user name and the token as the password.

Type: basic

Definitions

Name Description
GraphSubject

Top-level graph entity
GraphSubjectQuery

Subject to search using the Graph API
ReferenceLinks

The class to represent a collection of REST reference links.

GraphSubject

Top-level graph entity

Name Type Description
_links

ReferenceLinks

This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject.
descriptor

string

The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.
displayName

string

This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.
legacyDescriptor

string

[Internal Use Only] The legacy descriptor is here in case you need to access old version IMS using identity descriptor.
origin

string

The type of source provider for the origin identifier (ex:AD, AAD, MSA)
originId

string

The unique identifier from the system of origin. Typically a sid, object id or Guid. Linking and unlinking operations can cause this value to change for a user because the user is not backed by a different provider and has a different unique id in the new provider.
subjectKind

string

This field identifies the type of the graph subject (ex: Group, Scope, User).
url

string

This url is the full route to the source resource of this graph subject.

GraphSubjectQuery

Subject to search using the Graph API

Name Type Description
query

string

Search term to search for Azure Devops users or/and groups
scopeDescriptor

string

Optional parameter. Specify a non-default scope (collection, project) to search for users or groups within the scope.
subjectKind

string[]

"User" or "Group" can be specified, both or either

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.