GraphScope interface

  • Reference
Package:
azure-devops-extension-api

Container where a graph entity is defined (organization, project, team)

Extends
GraphSubject

Properties

administratorDescriptor

The subject descriptor that references the administrators group for this scope. Only members of this group can change the contents of this scope or assign other users permissions to access this scope.
isGlobal

When true, this scope is also a securing host for one or more scopes.
parentDescriptor

The subject descriptor for the closest account or organization in the ancestor tree of this scope.
scopeType

The type of this scope. Typically ServiceHost or TeamProject.
securingHostDescriptor

The subject descriptor for the containing organization in the ancestor tree of this scope.

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.
legacyDescriptor

[Internal Use Only] The legacy descriptor is here in case you need to access old version IMS using identity descriptor.
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.
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

administratorDescriptor

The subject descriptor that references the administrators group for this scope. Only members of this group can change the contents of this scope or assign other users permissions to access this scope.

administratorDescriptor: string

Property Value

string

isGlobal

When true, this scope is also a securing host for one or more scopes.

isGlobal: boolean

Property Value

boolean

parentDescriptor

The subject descriptor for the closest account or organization in the ancestor tree of this scope.

parentDescriptor: string

Property Value

string

scopeType

The type of this scope. Typically ServiceHost or TeamProject.

scopeType: GroupScopeType

Property Value

GroupScopeType

securingHostDescriptor

The subject descriptor for the containing organization in the ancestor tree of this scope.

securingHostDescriptor: 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 GraphSubject.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 GraphSubject.displayName

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 GraphSubject.legacyDescriptor

origin

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

origin: string

Property Value

string

Inherited From GraphSubject.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 GraphSubject.originId

subjectKind

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

subjectKind: string

Property Value

string

Inherited From GraphSubject.subjectKind

url

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

url: string

Property Value

string

Inherited From GraphSubject.url