Class: Azure::ARM::Web::Models::SiteAuthSettings

Inherits:
MsRestAzure::Resource
  • Object
show all
Includes:
MsRest::JSONable, MsRestAzure
Defined in:
lib/generated/azure_mgmt_web/models/site_auth_settings.rb

Overview

Configuration settings for the Azure App Service Authentication / Authorization feature.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#additional_login_params ⇒ Array<String>

authorization endpoint when a user logs in. Each parameter must be in the form “key=value”.

Returns:

  • (Array<String>) —

    Login parameters to send to the OpenID Connect



99
100
101
 
# File 'lib/generated/azure_mgmt_web/models/site_auth_settings.rb', line 99

def 
  @additional_login_params
end

#allowed_audiences ⇒ Array<String>

validating JWTs issued by Azure Active Directory. Note that the ClientID value is always considered an allowed audience, regardless of this setting.

Returns:

  • (Array<String>) —

    Allowed audience values to consider when



94
95
96
 
# File 'lib/generated/azure_mgmt_web/models/site_auth_settings.rb', line 94

def allowed_audiences
  @allowed_audiences
end

#allowed_external_redirect_urls ⇒ Array<String>

of logging in or logging out of the app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed.

Returns:

  • (Array<String>) —

    External URLs that can be redirected to as part



45
46
47
 
# File 'lib/generated/azure_mgmt_web/models/site_auth_settings.rb', line 45

def allowed_external_redirect_urls
  @allowed_external_redirect_urls
end

#client_id ⇒ String

as the client_id. This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers. More information on OpenID Connect: openid.net/specs/openid-connect-core-1_0.html

Returns:

  • (String) —

    The Client ID of this relying party application, known



68
69
70
 
# File 'lib/generated/azure_mgmt_web/models/site_auth_settings.rb', line 68

def client_id
  @client_id
end

#client_secret ⇒ String

(in Azure Active Directory, this is also referred to as the Key). This setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users. Otherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users. More information on OpenID Connect: openid.net/specs/openid-connect-core-1_0.html

Returns:

  • (String) —

    The Client Secret of this relying party application



78
79
80
 
# File 'lib/generated/azure_mgmt_web/models/site_auth_settings.rb', line 78

def client_secret
  @client_secret
end

#default_provider ⇒ BuiltInAuthenticationProvider

provider to use when multiple providers are configured. This setting is only needed if multiple providers are configured and the unauthenticated client action is set to “RedirectToLoginPage”. Possible values include: ‘AzureActiveDirectory’, ‘Facebook’, ‘Google’, ‘MicrosoftAccount’, ‘Twitter’

Returns:



54
55
56
 
# File 'lib/generated/azure_mgmt_web/models/site_auth_settings.rb', line 54

def default_provider
  @default_provider
end

#enabled ⇒ Boolean

Authorization feature is enabled for the current app; otherwise, false.

Returns:

  • (Boolean) —

    true if the Authentication /



20
21
22
 
# File 'lib/generated/azure_mgmt_web/models/site_auth_settings.rb', line 20

def enabled
  @enabled
end

#facebook_app_id ⇒ String

This setting is required for enabling Facebook Login. Facebook Login documentation: developers.facebook.com/docs/facebook-login

Returns:

  • (String) —

    The App ID of the Facebook app used for login.



127
128
129
 
# File 'lib/generated/azure_mgmt_web/models/site_auth_settings.rb', line 127

def facebook_app_id
  @facebook_app_id
end

#facebook_app_secret ⇒ String

Login. This setting is required for enabling Facebook Login. Facebook Login documentation: developers.facebook.com/docs/facebook-login

Returns:

  • (String) —

    The App Secret of the Facebook app used for Facebook



134
135
136
 
# File 'lib/generated/azure_mgmt_web/models/site_auth_settings.rb', line 134

def facebook_app_secret
  @facebook_app_secret
end

#facebook_oauth_scopes ⇒ Array<String>

part of Facebook Login authentication. This setting is optional. Facebook Login documentation: developers.facebook.com/docs/facebook-login

Returns:

  • (Array<String>) —

    The OAuth 2.0 scopes that will be requested as



141
142
143
 
# File 'lib/generated/azure_mgmt_web/models/site_auth_settings.rb', line 141

def facebook_oauth_scopes
  @facebook_oauth_scopes
end

#google_client_id ⇒ String

application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: developers.google.com/identity/sign-in/web/

Returns:

  • (String) —

    The OpenID Connect Client ID for the Google web



106
107
108
 
# File 'lib/generated/azure_mgmt_web/models/site_auth_settings.rb', line 106

def google_client_id
  @google_client_id
end

#google_client_secret ⇒ String

application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: developers.google.com/identity/sign-in/web/

Returns:

  • (String) —

    The client secret associated with the Google web



113
114
115
 
# File 'lib/generated/azure_mgmt_web/models/site_auth_settings.rb', line 113

def google_client_secret
  @google_client_secret
end

#google_oauth_scopes ⇒ Array<String>

part of Google Sign-In authentication. This setting is optional. If not specified, “openid”, “profile”, and “email” are used as default scopes. Google Sign-In documentation: developers.google.com/identity/sign-in/web/

Returns:

  • (Array<String>) —

    The OAuth 2.0 scopes that will be requested as



121
122
123
 
# File 'lib/generated/azure_mgmt_web/models/site_auth_settings.rb', line 121

def google_oauth_scopes
  @google_oauth_scopes
end

#issuer ⇒ String

entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. sts.windows.net/tenant-guid/. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: openid.net/specs/openid-connect-discovery-1_0.html

Returns:

  • (String) —

    The OpenID Connect Issuer URI that represents the



87
88
89
 
# File 'lib/generated/azure_mgmt_web/models/site_auth_settings.rb', line 87

def issuer
  @issuer
end

#microsoft_account_client_id ⇒ String

used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: dev.onedrive.com/auth/msa_oauth.htm

Returns:

  • (String) —

    The OAuth 2.0 client ID that was created for the app



160
161
162
 
# File 'lib/generated/azure_mgmt_web/models/site_auth_settings.rb', line 160

def 
  @microsoft_account_client_id
end

#microsoft_account_client_secret ⇒ String

app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: dev.onedrive.com/auth/msa_oauth.htm

Returns:

  • (String) —

    The OAuth 2.0 client secret that was created for the



167
168
169
 
# File 'lib/generated/azure_mgmt_web/models/site_auth_settings.rb', line 167

def 
  @microsoft_account_client_secret
end

#microsoft_account_oauth_scopes ⇒ Array<String>

part of Microsoft Account authentication. This setting is optional. If not specified, “wl.basic” is used as the default scope. Microsoft Account Scopes and permissions documentation: msdn.microsoft.com/en-us/library/dn631845.aspx

Returns:

  • (Array<String>) —

    The OAuth 2.0 scopes that will be requested as



175
176
177
 
# File 'lib/generated/azure_mgmt_web/models/site_auth_settings.rb', line 175

def 
  @microsoft_account_oauth_scopes
end

#runtime_version ⇒ String

Authorization feature in use for the current app. The setting in this value can control the behavior of certain features in the Authentication / Authorization module.

Returns:

  • (String) —

    The RuntimeVersion of the Authentication /



26
27
28
 
# File 'lib/generated/azure_mgmt_web/models/site_auth_settings.rb', line 26

def runtime_version
  @runtime_version
end

#token_refresh_extension_hours ⇒ Float

a session token can be used to call the token refresh API. The default is 72 hours.

Returns:

  • (Float) —

    The number of hours after session token expiration that



59
60
61
 
# File 'lib/generated/azure_mgmt_web/models/site_auth_settings.rb', line 59

def token_refresh_extension_hours
  @token_refresh_extension_hours
end

#token_store_enabled ⇒ Boolean

security tokens that are obtained during login flows; otherwise, false. The default is false.

Returns:

  • (Boolean) —

    true to durably store platform-specific



37
38
39
 
# File 'lib/generated/azure_mgmt_web/models/site_auth_settings.rb', line 37

def token_store_enabled
  @token_store_enabled
end

#twitter_consumer_key ⇒ String

used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: dev.twitter.com/web/sign-in

Returns:

  • (String) —

    The OAuth 1.0a consumer key of the Twitter application



147
148
149
 
# File 'lib/generated/azure_mgmt_web/models/site_auth_settings.rb', line 147

def twitter_consumer_key
  @twitter_consumer_key
end

#twitter_consumer_secret ⇒ String

application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: dev.twitter.com/web/sign-in

Returns:

  • (String) —

    The OAuth 1.0a consumer secret of the Twitter



153
154
155
 
# File 'lib/generated/azure_mgmt_web/models/site_auth_settings.rb', line 153

def twitter_consumer_secret
  @twitter_consumer_secret
end

#unauthenticated_client_action ⇒ UnauthenticatedClientAction

unauthenticated client attempts to access the app. Possible values include: ‘RedirectToLoginPage’, ‘AllowAnonymous’

Returns:



31
32
33
 
# File 'lib/generated/azure_mgmt_web/models/site_auth_settings.rb', line 31

def unauthenticated_client_action
  @unauthenticated_client_action
end

Class Method Details

.mapper ⇒ Object

Mapper for SiteAuthSettings class as Ruby Hash. This will be used for serialization/deserialization.



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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/generated/azure_mgmt_web/models/site_auth_settings.rb', line 182

def self.mapper()
  {
    required: false,
    serialized_name: 'SiteAuthSettings',
    type: {
      name: 'Composite',
      class_name: 'SiteAuthSettings',
      model_properties: {
        id: {
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          required: false,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        kind: {
          required: false,
          serialized_name: 'kind',
          type: {
            name: 'String'
          }
        },
        location: {
          required: true,
          serialized_name: 'location',
          type: {
            name: 'String'
          }
        },
        type: {
          required: false,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        tags: {
          required: false,
          serialized_name: 'tags',
          type: {
            name: 'Dictionary',
            value: {
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        enabled: {
          required: false,
          serialized_name: 'properties.enabled',
          type: {
            name: 'Boolean'
          }
        },
        runtime_version: {
          required: false,
          serialized_name: 'properties.runtimeVersion',
          type: {
            name: 'String'
          }
        },
        unauthenticated_client_action: {
          required: false,
          serialized_name: 'properties.unauthenticatedClientAction',
          type: {
            name: 'Enum',
            module: 'UnauthenticatedClientAction'
          }
        },
        token_store_enabled: {
          required: false,
          serialized_name: 'properties.tokenStoreEnabled',
          type: {
            name: 'Boolean'
          }
        },
        allowed_external_redirect_urls: {
          required: false,
          serialized_name: 'properties.allowedExternalRedirectUrls',
          type: {
            name: 'Sequence',
            element: {
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        default_provider: {
          required: false,
          serialized_name: 'properties.defaultProvider',
          type: {
            name: 'Enum',
            module: 'BuiltInAuthenticationProvider'
          }
        },
        token_refresh_extension_hours: {
          required: false,
          serialized_name: 'properties.tokenRefreshExtensionHours',
          type: {
            name: 'Double'
          }
        },
        client_id: {
          required: false,
          serialized_name: 'properties.clientId',
          type: {
            name: 'String'
          }
        },
        client_secret: {
          required: false,
          serialized_name: 'properties.clientSecret',
          type: {
            name: 'String'
          }
        },
        issuer: {
          required: false,
          serialized_name: 'properties.issuer',
          type: {
            name: 'String'
          }
        },
        allowed_audiences: {
          required: false,
          serialized_name: 'properties.allowedAudiences',
          type: {
            name: 'Sequence',
            element: {
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        additional_login_params: {
          required: false,
          serialized_name: 'properties.additionalLoginParams',
          type: {
            name: 'Sequence',
            element: {
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        google_client_id: {
          required: false,
          serialized_name: 'properties.googleClientId',
          type: {
            name: 'String'
          }
        },
        google_client_secret: {
          required: false,
          serialized_name: 'properties.googleClientSecret',
          type: {
            name: 'String'
          }
        },
        google_oauth_scopes: {
          required: false,
          serialized_name: 'properties.googleOAuthScopes',
          type: {
            name: 'Sequence',
            element: {
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        facebook_app_id: {
          required: false,
          serialized_name: 'properties.facebookAppId',
          type: {
            name: 'String'
          }
        },
        facebook_app_secret: {
          required: false,
          serialized_name: 'properties.facebookAppSecret',
          type: {
            name: 'String'
          }
        },
        facebook_oauth_scopes: {
          required: false,
          serialized_name: 'properties.facebookOAuthScopes',
          type: {
            name: 'Sequence',
            element: {
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        twitter_consumer_key: {
          required: false,
          serialized_name: 'properties.twitterConsumerKey',
          type: {
            name: 'String'
          }
        },
        twitter_consumer_secret: {
          required: false,
          serialized_name: 'properties.twitterConsumerSecret',
          type: {
            name: 'String'
          }
        },
        microsoft_account_client_id: {
          required: false,
          serialized_name: 'properties.microsoftAccountClientId',
          type: {
            name: 'String'
          }
        },
        microsoft_account_client_secret: {
          required: false,
          serialized_name: 'properties.microsoftAccountClientSecret',
          type: {
            name: 'String'
          }
        },
        microsoft_account_oauth_scopes: {
          required: false,
          serialized_name: 'properties.microsoftAccountOAuthScopes',
          type: {
            name: 'Sequence',
            element: {
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        }
      }
    }
  }
end