-
Notifications
You must be signed in to change notification settings - Fork 181
/
IdentityProviderContract.yml
212 lines (209 loc) · 6.99 KB
/
IdentityProviderContract.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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
### YamlMime:TSType
name: IdentityProviderContract
uid: '@azure/arm-apimanagement.IdentityProviderContract'
package: '@azure/arm-apimanagement'
summary: Identity Provider details.
fullName: IdentityProviderContract
remarks: ''
isDeprecated: false
type: interface
properties:
- name: allowedTenants
uid: '@azure/arm-apimanagement.IdentityProviderContract.allowedTenants'
package: '@azure/arm-apimanagement'
summary: List of Allowed Tenants when configuring Azure Active Directory login.
fullName: allowedTenants
remarks: ''
isDeprecated: false
syntax:
content: 'allowedTenants?: string[]'
return:
description: ''
type: string[]
- name: authority
uid: '@azure/arm-apimanagement.IdentityProviderContract.authority'
package: '@azure/arm-apimanagement'
summary: OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
fullName: authority
remarks: ''
isDeprecated: false
syntax:
content: 'authority?: string'
return:
description: ''
type: string
- name: clientId
uid: '@azure/arm-apimanagement.IdentityProviderContract.clientId'
package: '@azure/arm-apimanagement'
summary: >-
Client Id of the Application in the external Identity Provider. It is App
ID for Facebook login, Client ID for Google login, App ID for Microsoft.
fullName: clientId
remarks: ''
isDeprecated: false
syntax:
content: 'clientId?: string'
return:
description: ''
type: string
- name: clientLibrary
uid: '@azure/arm-apimanagement.IdentityProviderContract.clientLibrary'
package: '@azure/arm-apimanagement'
summary: >-
The client library to be used in the developer portal. Only applies to AAD
and AAD B2C Identity Provider.
fullName: clientLibrary
remarks: ''
isDeprecated: false
syntax:
content: 'clientLibrary?: string'
return:
description: ''
type: string
- name: clientSecret
uid: '@azure/arm-apimanagement.IdentityProviderContract.clientSecret'
package: '@azure/arm-apimanagement'
summary: >-
Client secret of the Application in external Identity Provider, used to
authenticate login request. For example, it is App Secret for Facebook
login, API Key for Google login, Public Key for Microsoft. This property
will not be filled on 'GET' operations! Use '/listSecrets' POST request to
get the value.
fullName: clientSecret
remarks: ''
isDeprecated: false
syntax:
content: 'clientSecret?: string'
return:
description: ''
type: string
- name: passwordResetPolicyName
uid: '@azure/arm-apimanagement.IdentityProviderContract.passwordResetPolicyName'
package: '@azure/arm-apimanagement'
summary: Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
fullName: passwordResetPolicyName
remarks: ''
isDeprecated: false
syntax:
content: 'passwordResetPolicyName?: string'
return:
description: ''
type: string
- name: profileEditingPolicyName
uid: '@azure/arm-apimanagement.IdentityProviderContract.profileEditingPolicyName'
package: '@azure/arm-apimanagement'
summary: Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
fullName: profileEditingPolicyName
remarks: ''
isDeprecated: false
syntax:
content: 'profileEditingPolicyName?: string'
return:
description: ''
type: string
- name: signinPolicyName
uid: '@azure/arm-apimanagement.IdentityProviderContract.signinPolicyName'
package: '@azure/arm-apimanagement'
summary: Signin Policy Name. Only applies to AAD B2C Identity Provider.
fullName: signinPolicyName
remarks: ''
isDeprecated: false
syntax:
content: 'signinPolicyName?: string'
return:
description: ''
type: string
- name: signinTenant
uid: '@azure/arm-apimanagement.IdentityProviderContract.signinTenant'
package: '@azure/arm-apimanagement'
summary: The TenantId to use instead of Common when logging into Active Directory
fullName: signinTenant
remarks: ''
isDeprecated: false
syntax:
content: 'signinTenant?: string'
return:
description: ''
type: string
- name: signupPolicyName
uid: '@azure/arm-apimanagement.IdentityProviderContract.signupPolicyName'
package: '@azure/arm-apimanagement'
summary: Signup Policy Name. Only applies to AAD B2C Identity Provider.
fullName: signupPolicyName
remarks: ''
isDeprecated: false
syntax:
content: 'signupPolicyName?: string'
return:
description: ''
type: string
- name: typePropertiesType
uid: '@azure/arm-apimanagement.IdentityProviderContract.typePropertiesType'
package: '@azure/arm-apimanagement'
summary: Identity Provider Type identifier.
fullName: typePropertiesType
remarks: ''
isDeprecated: false
syntax:
content: 'typePropertiesType?: string'
return:
description: ''
type: string
inheritedProperties:
- name: id
uid: '@azure/arm-apimanagement.IdentityProviderContract.id'
package: '@azure/arm-apimanagement'
summary: >-
Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: id
remarks: ''
isDeprecated: false
syntax:
content: 'id?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[ProxyResource.id](xref:@azure/arm-apimanagement.ProxyResource.id)
- name: name
uid: '@azure/arm-apimanagement.IdentityProviderContract.name'
package: '@azure/arm-apimanagement'
summary: >-
The name of the resource
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: name
remarks: ''
isDeprecated: false
syntax:
content: 'name?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[ProxyResource.name](xref:@azure/arm-apimanagement.ProxyResource.name)
- name: type
uid: '@azure/arm-apimanagement.IdentityProviderContract.type'
package: '@azure/arm-apimanagement'
summary: >-
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts"
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: type
remarks: ''
isDeprecated: false
syntax:
content: 'type?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[ProxyResource.type](xref:@azure/arm-apimanagement.ProxyResource.type)
extends: <xref uid="@azure/arm-apimanagement.ProxyResource" />