Interface IdentityReference

Describes a reference to an identity.

interface IdentityReference {
    _links?: any;
    descriptor?: string;
    directoryAlias?: string;
    displayName?: string;
    id?: string;
    imageUrl?: string;
    inactive?: boolean;
    isAadIdentity?: boolean;
    isContainer?: boolean;
    isDeletedInOrigin?: boolean;
    name?: string;
    profileUrl?: string;
    uniqueName?: string;
    url?: string;
}

Hierarchy (View Summary)

Properties

_links? descriptor? directoryAlias? displayName? id? imageUrl? inactive? isAadIdentity? isContainer? isDeletedInOrigin? name? profileUrl? uniqueName? 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.

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

Deprecated - Can be retrieved by querying the Graph user referenced in the "self" entry of the IdentityRef "_links" dictionary

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.

Optionalid

id?: string

Gets or sets the identifier of the identity.

OptionalimageUrl

imageUrl?: string

Deprecated - Available in the "avatar" entry of the IdentityRef "_links" dictionary

Optionalinactive

inactive?: boolean

Deprecated - Can be retrieved by querying the Graph membership state referenced in the "membershipState" entry of the GraphUser "_links" dictionary

OptionalisAadIdentity

isAadIdentity?: boolean

Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)

OptionalisContainer

isContainer?: boolean

Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)

OptionalisDeletedInOrigin

isDeletedInOrigin?: boolean

Optionalname

name?: string

Legacy back-compat property. This has been the WIT specific value from Constants. Will be hidden (but exists) on the client unless they are targeting the newest version

OptionalprofileUrl

profileUrl?: string

Deprecated - not in use in most preexisting implementations of ToIdentityRef

OptionaluniqueName

uniqueName?: string

Deprecated - use Domain+PrincipalName instead

Optionalurl

url?: string

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

Settings

Member Visibility

On This Page

Properties