IdentityBase interface

Package:

azure-devops-extension-api

Base Identity class to allow "trimmed" identity class in the GetConnectionData API Makes sure that on-the-wire representations of the derived classes are compatible with each other (e.g. Server responds with PublicIdentity object while client deserializes it as Identity object) Derived classes should not have additional [DataMember] properties

Properties

customDisplayName	The custom display name for the identity (if any). Setting this property to an empty string will clear the existing custom display name. Setting this property to null will not affect the existing persisted value (since null values do not get sent over the wire or to the database)
descriptor
id	Identity Identifier. Also called Storage Key, or VSID
isActive	True if the identity has a membership in any Azure Devops group in the organization.
isContainer	True if the identity is a group.
masterId
memberIds	Id of the members of the identity (groups only).
memberOf
members
metaTypeId
properties
providerDisplayName	The display name for the identity as specified by the source identity provider.
resourceVersion
socialDescriptor
subjectDescriptor	Subject descriptor of a Graph entity.
uniqueUserId

Property Details

customDisplayName

The custom display name for the identity (if any). Setting this property to an empty string will clear the existing custom display name. Setting this property to null will not affect the existing persisted value (since null values do not get sent over the wire or to the database)

customDisplayName: string

Property Value

string

descriptor

descriptor: IdentityDescriptor

Property Value

IdentityDescriptor

id

Identity Identifier. Also called Storage Key, or VSID

id: string

Property Value

string

isActive

True if the identity has a membership in any Azure Devops group in the organization.

isActive: boolean

Property Value

boolean

isContainer

True if the identity is a group.

isContainer: boolean

Property Value

boolean

masterId

masterId: string

Property Value

string

memberIds

Id of the members of the identity (groups only).

memberIds: string[]

Property Value

string[]

memberOf

memberOf: IdentityDescriptor[]

Property Value

IdentityDescriptor[]

members

members: IdentityDescriptor[]

Property Value

IdentityDescriptor[]

metaTypeId

metaTypeId: number

Property Value

number

properties

properties: any

Property Value

any

providerDisplayName

The display name for the identity as specified by the source identity provider.

providerDisplayName: string

Property Value

string

resourceVersion

resourceVersion: number

Property Value

number

socialDescriptor

socialDescriptor: string

Property Value

string

subjectDescriptor

Subject descriptor of a Graph entity.

subjectDescriptor: string

Property Value

string

uniqueUserId

uniqueUserId: number

Property Value

number