IdentityReference interface

Package:

azure-devops-extension-api

Describes a reference to an identity.

Extends

IdentityRef

Properties

id	Gets or sets the identifier of the identity.
name	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

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.
directoryAlias	Deprecated - Can be retrieved by querying the Graph user referenced in the "self" entry of the IdentityRef "_links" dictionary
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.
imageUrl	Deprecated - Available in the "avatar" entry of the IdentityRef "_links" dictionary
inactive	Deprecated - Can be retrieved by querying the Graph membership state referenced in the "membershipState" entry of the GraphUser "_links" dictionary
isAadIdentity	Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)
isDeletedInOrigin
profileUrl	Deprecated - not in use in most preexisting implementations of ToIdentityRef
uniqueName	Deprecated - use Domain+PrincipalName instead
url	This url is the full route to the source resource of this graph subject.

Property Details

id

Gets or sets the identifier of the identity.

id: string

Property Value

string

name

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

name: 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 IdentityRef.descriptor

directoryAlias

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

directoryAlias: string

Property Value

string

Inherited From IdentityRef.directoryAlias

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 IdentityRef.displayName

imageUrl

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

imageUrl: string

Property Value

string

Inherited From IdentityRef.imageUrl

inactive

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

inactive: boolean

Property Value

boolean

Inherited From IdentityRef.inactive

isAadIdentity

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

isAadIdentity: boolean

Property Value

boolean

Inherited From IdentityRef.isAadIdentity

isContainer

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

isContainer: boolean

Property Value

boolean

Inherited From IdentityRef.isContainer

isDeletedInOrigin

isDeletedInOrigin: boolean

Property Value

boolean

Inherited From IdentityRef.isDeletedInOrigin

profileUrl

Deprecated - not in use in most preexisting implementations of ToIdentityRef

profileUrl: string

Property Value

string

Inherited From IdentityRef.profileUrl

uniqueName

Deprecated - use Domain+PrincipalName instead

uniqueName: string

Property Value

string

Inherited From IdentityRef.uniqueName

url

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

url: string

Property Value

string

Inherited From IdentityRef.url