Groups - Get

Reference

Service:: Graph

API Version:: 6.0-preview.1

Get a group by its descriptor.

The group will be returned even if it has been deleted from the account or has had all its memberships deleted.

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

URI Parameters

Name	In	Required	Type	Description
groupDescriptor	path	True	string	The descriptor of the desired graph group.
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 '6.0-preview.1' to use this version of the api.

Responses

Name	Type	Description
200 OK	GraphGroup	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/{organization}/_apis/graph/groups/{groupDescriptor}?api-version=6.0-preview.1

Sample Response

Status code:: 200

{
  "subjectKind": "group",
  "description": "Full time employees working on Fabrikam",
  "isCrossProject": true,
  "domain": "vstfs:///Framework/IdentityDomain/9b4f7336-c130-40bd-87f3-4201361ddbd1",
  "principalName": "[TEAM FOUNDATION]\\Full Time Engineers",
  "mailAddress": null,
  "origin": "aad",
  "originId": "77ed2186-aaf6-4299-ac9e-37ba282c2b95",
  "displayName": "Full Time Engineers",
  "_links": {
    "self": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Groups/aadgp.Uy0xLTktMTU1MTM3NDI0NS0xMjA0NDAwOTY5LTI0MDI5ODY0MTMtMjE3OTQwODYxNi0zLTIyNTAzNzA0MjMtNDEzODM3NTQ5MC0yODk2MDUwMTA2LTY3Mzk4MzM4MQ"
    },
    "memberships": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Memberships/aadgp.Uy0xLTktMTU1MTM3NDI0NS0xMjA0NDAwOTY5LTI0MDI5ODY0MTMtMjE3OTQwODYxNi0zLTIyNTAzNzA0MjMtNDEzODM3NTQ5MC0yODk2MDUwMTA2LTY3Mzk4MzM4MQ"
    },
    "membershipState": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/MembershipStates/aadgp.Uy0xLTktMTU1MTM3NDI0NS0xMjA0NDAwOTY5LTI0MDI5ODY0MTMtMjE3OTQwODYxNi0zLTIyNTAzNzA0MjMtNDEzODM3NTQ5MC0yODk2MDUwMTA2LTY3Mzk4MzM4MQ"
    },
    "storageKey": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/StorageKeys/aadgp.Uy0xLTktMTU1MTM3NDI0NS0xMjA0NDAwOTY5LTI0MDI5ODY0MTMtMjE3OTQwODYxNi0zLTIyNTAzNzA0MjMtNDEzODM3NTQ5MC0yODk2MDUwMTA2LTY3Mzk4MzM4MQ"
    }
  },
  "url": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Groups/aadgp.Uy0xLTktMTU1MTM3NDI0NS0xMjA0NDAwOTY5LTI0MDI5ODY0MTMtMjE3OTQwODYxNi0zLTIyNTAzNzA0MjMtNDEzODM3NTQ5MC0yODk2MDUwMTA2LTY3Mzk4MzM4MQ",
  "descriptor": "aadgp.Uy0xLTktMTU1MTM3NDI0NS0xMjA0NDAwOTY5LTI0MDI5ODY0MTMtMjE3OTQwODYxNi0zLTIyNTAzNzA0MjMtNDEzODM3NTQ5MC0yODk2MDUwMTA2LTY3Mzk4MzM4MQ"
}

Definitions

Name	Description
GraphGroup	Graph group entity
ReferenceLinks	The class to represent a collection of REST reference links.

GraphGroup

Graph group 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.
description	string	A short phrase to help human readers disambiguate groups with similar names
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.
domain	string	This represents the name of the container of origin for a graph member. (For MSA this is "Windows Live ID", for AD the name of the domain, for AAD the tenantID of the directory, for VSTS groups the ScopeId, etc)
legacyDescriptor	string	[Internal Use Only] The legacy descriptor is here in case you need to access old version IMS using identity descriptor.
mailAddress	string	The email address of record for a given graph member. This may be different than the principal name.
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.
principalName	string	This is the PrincipalName of this graph member from the source provider. The source provider may change this field over time and it is not guaranteed to be immutable for the life of the graph member by VSTS.
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.

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.