-
Notifications
You must be signed in to change notification settings - Fork 10
/
IVssIdentityService.yml
117 lines (117 loc) · 4.57 KB
/
IVssIdentityService.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
### YamlMime:TSType
name: IVssIdentityService
uid: azure-devops-extension-api.IVssIdentityService
package: azure-devops-extension-api
summary: ''
fullName: IVssIdentityService
remarks: ''
isDeprecated: false
type: interface
methods:
- name: addMruIdentitiesAsync(IIdentity[])
uid: azure-devops-extension-api.IVssIdentityService.addMruIdentitiesAsync
package: azure-devops-extension-api
summary: Add a list of identities to the MRU
remarks: ''
isDeprecated: false
syntax:
content: >-
function addMruIdentitiesAsync(identities: IIdentity[]):
Promise<boolean>
parameters:
- id: identities
type: <xref uid="azure-devops-extension-api.IIdentity" />[]
description: list of IdentityRefs to add to the MRU
return:
description: True if the item was added, false otherwise
type: Promise<boolean>
- name: getConnections(IIdentity, boolean)
uid: azure-devops-extension-api.IVssIdentityService.getConnections
package: azure-devops-extension-api
summary: Gets a list of connections for a given identity
remarks: ''
isDeprecated: false
syntax:
content: >-
function getConnections(identity: IIdentity, getDirectReports?:
boolean): Promise<IdentitiesGetConnectionsResponseModel>
parameters:
- id: identity
type: <xref uid="azure-devops-extension-api.IIdentity" />
description: Entity to look up connections
- id: getDirectReports
type: boolean
description: ''
return:
description: Connections for the given identity
type: >-
Promise<<xref
uid="azure-devops-extension-api.IdentitiesGetConnectionsResponseModel"
/>>
- name: getIdentityMruAsync()
uid: azure-devops-extension-api.IVssIdentityService.getIdentityMruAsync
package: azure-devops-extension-api
summary: Get a list of the Most Recently Used (MRU) identities
remarks: ''
isDeprecated: false
syntax:
content: 'function getIdentityMruAsync(): Promise<IIdentity[]>'
return:
description: list of the Most Recently Used (MRU) identities
type: Promise<<xref uid="azure-devops-extension-api.IIdentity" />[]>
- name: removeMruIdentitiesAsync(IIdentity[])
uid: azure-devops-extension-api.IVssIdentityService.removeMruIdentitiesAsync
package: azure-devops-extension-api
summary: Remove a list of identities from the MRU
remarks: ''
isDeprecated: false
syntax:
content: >-
function removeMruIdentitiesAsync(identity: IIdentity[]):
Promise<boolean>
parameters:
- id: identity
type: <xref uid="azure-devops-extension-api.IIdentity" />[]
description: ''
return:
description: True if the item was removed, false otherwise
type: Promise<boolean>
- name: >-
searchIdentitiesAsync(string, string[], string[], string, any,
(returnedEntities: IIdentity[]) => IIdentity[])
uid: azure-devops-extension-api.IVssIdentityService.searchIdentitiesAsync
package: azure-devops-extension-api
summary: >-
Given a search request model, return a list of Entities. If the
filterIdentity callback is added, additionally filter the values before
returning
remarks: ''
isDeprecated: false
syntax:
content: >-
function searchIdentitiesAsync(query: string, identityTypes?: string[],
operationScopes?: string[], queryTypeHint?: string, options?: any,
filterIdentity?: (returnedEntities: IIdentity[]) => IIdentity[]):
Promise<IIdentity[]>
parameters:
- id: query
type: string
description: The query to search the identities type with.
- id: identityTypes
type: string[]
description: The types of identities to search (default "user" and "group")
- id: operationScopes
type: string[]
description: The scope you would like to search (default "ims", "source")
- id: queryTypeHint
type: string
description: A hint of what property your query is trying to search
- id: options
type: any
description: Additional options to pass into the search
- id: filterIdentity
type: '(returnedEntities: IIdentity[]) => IIdentity[]'
description: A filter passed in to alter the results of the identities found
return:
description: The list of filtered identities from the search.
type: Promise<<xref uid="azure-devops-extension-api.IIdentity" />[]>