Interface GraphScope

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

interface GraphScope {
    _links?: any;
    administratorDescriptor?: string;
    descriptor?: string;
    displayName?: string;
    isGlobal?: boolean;
    legacyDescriptor?: string;
    origin?: string;
    originId?: string;
    parentDescriptor?: string;
    scopeType?: GroupScopeType;
    securingHostDescriptor?: string;
    subjectKind?: string;
    url?: string;
}

Hierarchy (View Summary)

Properties

_links? administratorDescriptor? descriptor? displayName? isGlobal? legacyDescriptor? origin? originId? parentDescriptor? scopeType? securingHostDescriptor? subjectKind? url?

Properties

Optional_links

_links?: any

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.

OptionaladministratorDescriptor

administratorDescriptor?: string

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.

Optionaldescriptor

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.

OptionaldisplayName

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.

OptionalisGlobal

isGlobal?: boolean

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

OptionallegacyDescriptor

legacyDescriptor?: string

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

Optionalorigin

origin?: string

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

OptionaloriginId

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.

OptionalparentDescriptor

parentDescriptor?: string

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

OptionalscopeType

scopeType?: GroupScopeType

The type of this scope. Typically ServiceHost or TeamProject.

OptionalsecuringHostDescriptor

securingHostDescriptor?: string

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

OptionalsubjectKind

subjectKind?: string

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

Optionalurl

url?: string

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

Settings

Member Visibility

On This Page

Properties