AadGraphMember interface
Top-level graph entity
- Extends
Properties
directory |
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. |
is |
When true, the group has been deleted in the identity provider |
metadata |
|
meta |
The meta type of the user in the origin, such as "member", "guest", etc. See UserMetaType for the set of possible values. |
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. |
display |
This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider. |
domain | 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) |
legacy |
[Internal Use Only] The legacy descriptor is here in case you need to access old version IMS using identity descriptor. |
mail |
The email address of record for a given graph member. This may be different than the principal name. |
origin | The type of source provider for the origin identifier (ex:AD, AAD, MSA) |
origin |
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. |
principal |
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. |
subject |
This field identifies the type of the graph subject (ex: Group, Scope, User). |
url | This url is the full route to the source resource of this graph subject. |
Property Details
directoryAlias
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.
directoryAlias: string
Property Value
string
isDeletedInOrigin
When true, the group has been deleted in the identity provider
isDeletedInOrigin: boolean
Property Value
boolean
metadataUpdateDate
metadataUpdateDate: Date
Property Value
Date
metaType
The meta type of the user in the origin, such as "member", "guest", etc. See UserMetaType for the set of possible values.
metaType: 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 GraphMember.descriptor
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 GraphMember.displayName
domain
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)
domain: string
Property Value
string
Inherited From GraphMember.domain
legacyDescriptor
[Internal Use Only] The legacy descriptor is here in case you need to access old version IMS using identity descriptor.
legacyDescriptor: string
Property Value
string
Inherited From GraphMember.legacyDescriptor
mailAddress
The email address of record for a given graph member. This may be different than the principal name.
mailAddress: string
Property Value
string
Inherited From GraphMember.mailAddress
origin
The type of source provider for the origin identifier (ex:AD, AAD, MSA)
origin: string
Property Value
string
Inherited From GraphMember.origin
originId
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.
originId: string
Property Value
string
Inherited From GraphMember.originId
principalName
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.
principalName: string
Property Value
string
Inherited From GraphMember.principalName
subjectKind
This field identifies the type of the graph subject (ex: Group, Scope, User).
subjectKind: string
Property Value
string
Inherited From GraphMember.subjectKind
url
This url is the full route to the source resource of this graph subject.
url: string
Property Value
string
Inherited From GraphMember.url