Interface GraphServicePrincipal

Top-level graph entity

interface GraphServicePrincipal {
    _links?: any;
    applicationId?: string;
    descriptor?: string;
    directoryAlias?: string;
    displayName?: string;
    domain?: string;
    isDeletedInOrigin?: boolean;
    legacyDescriptor?: string;
    mailAddress?: string;
    metadataUpdateDate?: Date;
    metaType?: string;
    origin?: string;
    originId?: string;
    principalName?: string;
    subjectKind?: string;
    url?: string;
}

Hierarchy (View Summary)

Properties

_links? applicationId? descriptor? directoryAlias? displayName? domain? isDeletedInOrigin? legacyDescriptor? mailAddress? metadataUpdateDate? metaType? origin? originId? principalName? 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.

OptionalapplicationId

applicationId?: string

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.

OptionaldirectoryAlias

directoryAlias?: string

The short, generally unique name for the user in the backing directory. For AAD users, this corresponds to the mail nickname, which is often but not necessarily similar to the part of the user's mail address before the @ sign. For GitHub users, this corresponds to the GitHub user handle.

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.

Optionaldomain

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)

OptionalisDeletedInOrigin

isDeletedInOrigin?: boolean

When true, the group has been deleted in the identity provider

OptionallegacyDescriptor

legacyDescriptor?: string

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

OptionalmailAddress

mailAddress?: string

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

OptionalmetadataUpdateDate

metadataUpdateDate?: Date

OptionalmetaType

metaType?: string

The meta type of the user in the origin, such as "member", "guest", etc. See UserMetaType for the set of possible values.

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.

OptionalprincipalName

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.

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