IVssIdentityService interface

Package:

azure-devops-extension-api

Methods

addMruIdentitiesAsync(IIdentity[])	Add a list of identities to the MRU
getConnections(IIdentity, boolean)	Gets a list of connections for a given identity
getIdentityMruAsync()	Get a list of the Most Recently Used (MRU) identities
removeMruIdentitiesAsync(IIdentity[])	Remove a list of identities from the MRU
searchIdentitiesAsync(string, string[], string[], string, any, (returnedEntities: IIdentity[]) => IIdentity[])	Given a search request model, return a list of Entities. If the filterIdentity callback is added, additionally filter the values before returning

Method Details

addMruIdentitiesAsync(IIdentity[])

Add a list of identities to the MRU

function addMruIdentitiesAsync(identities: IIdentity[]): Promise<boolean>

Parameters

identities

IIdentity[]

list of IdentityRefs to add to the MRU

Returns

Promise<boolean>

True if the item was added, false otherwise

getConnections(IIdentity, boolean)

Gets a list of connections for a given identity

function getConnections(identity: IIdentity, getDirectReports?: boolean): Promise<IdentitiesGetConnectionsResponseModel>

Parameters

identity

IIdentity

Entity to look up connections

getDirectReports

boolean

Returns

Promise<IdentitiesGetConnectionsResponseModel>

Connections for the given identity

getIdentityMruAsync()

Get a list of the Most Recently Used (MRU) identities

function getIdentityMruAsync(): Promise<IIdentity[]>

Returns

Promise<IIdentity[]>

list of the Most Recently Used (MRU) identities

removeMruIdentitiesAsync(IIdentity[])

Remove a list of identities from the MRU

function removeMruIdentitiesAsync(identity: IIdentity[]): Promise<boolean>

Parameters

identity

IIdentity[]

Returns

Promise<boolean>

True if the item was removed, false otherwise

searchIdentitiesAsync(string, string[], string[], string, any, (returnedEntities: IIdentity[]) => IIdentity[])

Given a search request model, return a list of Entities. If the filterIdentity callback is added, additionally filter the values before returning

function searchIdentitiesAsync(query: string, identityTypes?: string[], operationScopes?: string[], queryTypeHint?: string, options?: any, filterIdentity?: (returnedEntities: IIdentity[]) => IIdentity[]): Promise<IIdentity[]>

Parameters

query

string

The query to search the identities type with.

identityTypes

string[]

The types of identities to search (default "user" and "group")

operationScopes

string[]

The scope you would like to search (default "ims", "source")

queryTypeHint

string

A hint of what property your query is trying to search

options

any

Additional options to pass into the search

filterIdentity

(returnedEntities: IIdentity[]) => IIdentity[]

A filter passed in to alter the results of the identities found

Returns

Promise<IIdentity[]>

The list of filtered identities from the search.