Edit

Share via

GraphGroup interface

  • Reference
Package:
azure-devops-extension-api

Graph group entity

Extends
GraphMember

Properties

description

A short phrase to help human readers disambiguate groups with similar names
isCrossProject
isDeleted
isGlobalScope
isRestrictedVisible
localScopeId
scopeId
scopeName
scopeType
securingHostId
specialType

Inherited Properties

descriptor

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

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

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

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

The email address of record for a given graph member. This may be different than the principal name.
origin

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

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

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

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

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

Property Details

description

A short phrase to help human readers disambiguate groups with similar names

description: string

Property Value

string

isCrossProject 

isCrossProject: boolean

Property Value

boolean

isDeleted 

isDeleted: boolean

Property Value

boolean

isGlobalScope 

isGlobalScope: boolean

Property Value

boolean

isRestrictedVisible 

isRestrictedVisible: boolean

Property Value

boolean

localScopeId 

localScopeId: string

Property Value

string

scopeId 

scopeId: string

Property Value

string

scopeName 

scopeName: string

Property Value

string

scopeType 

scopeType: string

Property Value

string

securingHostId 

securingHostId: string

Property Value

string

specialType 

specialType: string

Property Value

string

Inherited Property Details

descriptor

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.

descriptor: string

Property Value

string

Inherited From GraphMember.descriptor

displayName

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

displayName: string

Property Value

string

Inherited From GraphMember.displayName

domain

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)

domain: string

Property Value

string

Inherited From GraphMember.domain

legacyDescriptor

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

legacyDescriptor: string

Property Value

string

Inherited From GraphMember.legacyDescriptor

mailAddress

The email address of record for a given graph member. This may be different than the principal name.

mailAddress: string

Property Value

string

Inherited From GraphMember.mailAddress

origin

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

origin: string

Property Value

string

Inherited From GraphMember.origin

originId

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.

originId: string

Property Value

string

Inherited From GraphMember.originId

principalName

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.

principalName: string

Property Value

string

Inherited From GraphMember.principalName

subjectKind

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

subjectKind: string

Property Value

string

Inherited From GraphMember.subjectKind

url

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

url: string

Property Value

string

Inherited From GraphMember.url