This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
azure-native.web.listWebAppAuthSettingsSlot
Explore with Pulumi AI
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
Description for Gets the Authentication/Authorization settings of an app. Azure REST API version: 2022-09-01.
Other available API versions: 2020-10-01, 2023-01-01, 2023-12-01, 2024-04-01.
Using listWebAppAuthSettingsSlot
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function listWebAppAuthSettingsSlot(args: ListWebAppAuthSettingsSlotArgs, opts?: InvokeOptions): Promise<ListWebAppAuthSettingsSlotResult>
function listWebAppAuthSettingsSlotOutput(args: ListWebAppAuthSettingsSlotOutputArgs, opts?: InvokeOptions): Output<ListWebAppAuthSettingsSlotResult>
def list_web_app_auth_settings_slot(name: Optional[str] = None,
resource_group_name: Optional[str] = None,
slot: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> ListWebAppAuthSettingsSlotResult
def list_web_app_auth_settings_slot_output(name: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
slot: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[ListWebAppAuthSettingsSlotResult]
func ListWebAppAuthSettingsSlot(ctx *Context, args *ListWebAppAuthSettingsSlotArgs, opts ...InvokeOption) (*ListWebAppAuthSettingsSlotResult, error)
func ListWebAppAuthSettingsSlotOutput(ctx *Context, args *ListWebAppAuthSettingsSlotOutputArgs, opts ...InvokeOption) ListWebAppAuthSettingsSlotResultOutput
> Note: This function is named ListWebAppAuthSettingsSlot
in the Go SDK.
public static class ListWebAppAuthSettingsSlot
{
public static Task<ListWebAppAuthSettingsSlotResult> InvokeAsync(ListWebAppAuthSettingsSlotArgs args, InvokeOptions? opts = null)
public static Output<ListWebAppAuthSettingsSlotResult> Invoke(ListWebAppAuthSettingsSlotInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<ListWebAppAuthSettingsSlotResult> listWebAppAuthSettingsSlot(ListWebAppAuthSettingsSlotArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:web:listWebAppAuthSettingsSlot
arguments:
# arguments dictionary
The following arguments are supported:
- Name string
- Name of the app.
- Resource
Group stringName - Name of the resource group to which the resource belongs.
- Slot string
- Name of the deployment slot. If a slot is not specified, the API will get the settings for the production slot.
- Name string
- Name of the app.
- Resource
Group stringName - Name of the resource group to which the resource belongs.
- Slot string
- Name of the deployment slot. If a slot is not specified, the API will get the settings for the production slot.
- name String
- Name of the app.
- resource
Group StringName - Name of the resource group to which the resource belongs.
- slot String
- Name of the deployment slot. If a slot is not specified, the API will get the settings for the production slot.
- name string
- Name of the app.
- resource
Group stringName - Name of the resource group to which the resource belongs.
- slot string
- Name of the deployment slot. If a slot is not specified, the API will get the settings for the production slot.
- name str
- Name of the app.
- resource_
group_ strname - Name of the resource group to which the resource belongs.
- slot str
- Name of the deployment slot. If a slot is not specified, the API will get the settings for the production slot.
- name String
- Name of the app.
- resource
Group StringName - Name of the resource group to which the resource belongs.
- slot String
- Name of the deployment slot. If a slot is not specified, the API will get the settings for the production slot.
listWebAppAuthSettingsSlot Result
The following output properties are available:
- Id string
- Resource Id.
- Name string
- Resource Name.
- Type string
- Resource type.
- string
- Gets a JSON string containing the Azure AD Acl settings.
- Additional
Login List<string>Params - Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value".
- Allowed
Audiences List<string> - Allowed audience values to consider when validating JSON Web Tokens issued by Azure Active Directory. Note that the ClientID value is always considered an allowed audience, regardless of this setting.
- Allowed
External List<string>Redirect Urls - External URLs that can be redirected to as part 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.
- Auth
File stringPath - The path of the config file containing auth settings. If the path is relative, base will the site's root directory.
- Client
Id string - The Client ID of this relying party application, known 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: http://openid.net/specs/openid-connect-core-1_0.html
- Client
Secret string - The Client Secret of this relying party application (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: http://openid.net/specs/openid-connect-core-1_0.html
- Client
Secret stringCertificate Thumbprint - An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as a replacement for the Client Secret. It is also optional.
- Client
Secret stringSetting Name - The app setting name that contains the client secret of the relying party application.
- Config
Version string - The ConfigVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of the control plane for Authentication / Authorization.
- Default
Provider string - The default authentication 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".
- Enabled bool
- true if the Authentication / Authorization feature is enabled for the current app; otherwise, false.
- Facebook
App stringId - The App ID of the Facebook app used for login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
- Facebook
App stringSecret - The App Secret of the Facebook app used for Facebook Login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
- Facebook
App stringSecret Setting Name - The app setting name that contains the app secret used for Facebook Login.
- Facebook
OAuth List<string>Scopes - The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication. This setting is optional. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
- Git
Hub stringClient Id - The Client Id of the GitHub app used for login. This setting is required for enabling Github login
- Git
Hub stringClient Secret - The Client Secret of the GitHub app used for Github Login. This setting is required for enabling Github login.
- Git
Hub stringClient Secret Setting Name - The app setting name that contains the client secret of the Github app used for GitHub Login.
- Git
Hub List<string>OAuth Scopes - The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. This setting is optional
- Google
Client stringId - The OpenID Connect Client ID for the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/
- Google
Client stringSecret - The client secret associated with the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/
- Google
Client stringSecret Setting Name - The app setting name that contains the client secret associated with the Google web application.
- Google
OAuth List<string>Scopes - The OAuth 2.0 scopes that will be requested as 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: https://developers.google.com/identity/sign-in/web/
- Is
Auth stringFrom File - "true" if the auth config settings should be read from a file, "false" otherwise
- Issuer string
- The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html
- Kind string
- Kind of resource.
- Microsoft
Account stringClient Id - The OAuth 2.0 client ID that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm
- Microsoft
Account stringClient Secret - The OAuth 2.0 client secret that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm
- Microsoft
Account stringClient Secret Setting Name - The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication.
- Microsoft
Account List<string>OAuth Scopes - The OAuth 2.0 scopes that will be requested as 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: https://msdn.microsoft.com/en-us/library/dn631845.aspx
- Runtime
Version string - The RuntimeVersion of the Authentication / 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.
- Token
Refresh doubleExtension Hours - The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours.
- Token
Store boolEnabled - true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. The default is false.
- Twitter
Consumer stringKey - The OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in
- Twitter
Consumer stringSecret - The OAuth 1.0a consumer secret of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in
- Twitter
Consumer stringSecret Setting Name - The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.
- Unauthenticated
Client stringAction - The action to take when an unauthenticated client attempts to access the app.
- Validate
Issuer bool - Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such.
- Id string
- Resource Id.
- Name string
- Resource Name.
- Type string
- Resource type.
- string
- Gets a JSON string containing the Azure AD Acl settings.
- Additional
Login []stringParams - Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value".
- Allowed
Audiences []string - Allowed audience values to consider when validating JSON Web Tokens issued by Azure Active Directory. Note that the ClientID value is always considered an allowed audience, regardless of this setting.
- Allowed
External []stringRedirect Urls - External URLs that can be redirected to as part 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.
- Auth
File stringPath - The path of the config file containing auth settings. If the path is relative, base will the site's root directory.
- Client
Id string - The Client ID of this relying party application, known 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: http://openid.net/specs/openid-connect-core-1_0.html
- Client
Secret string - The Client Secret of this relying party application (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: http://openid.net/specs/openid-connect-core-1_0.html
- Client
Secret stringCertificate Thumbprint - An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as a replacement for the Client Secret. It is also optional.
- Client
Secret stringSetting Name - The app setting name that contains the client secret of the relying party application.
- Config
Version string - The ConfigVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of the control plane for Authentication / Authorization.
- Default
Provider string - The default authentication 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".
- Enabled bool
- true if the Authentication / Authorization feature is enabled for the current app; otherwise, false.
- Facebook
App stringId - The App ID of the Facebook app used for login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
- Facebook
App stringSecret - The App Secret of the Facebook app used for Facebook Login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
- Facebook
App stringSecret Setting Name - The app setting name that contains the app secret used for Facebook Login.
- Facebook
OAuth []stringScopes - The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication. This setting is optional. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
- Git
Hub stringClient Id - The Client Id of the GitHub app used for login. This setting is required for enabling Github login
- Git
Hub stringClient Secret - The Client Secret of the GitHub app used for Github Login. This setting is required for enabling Github login.
- Git
Hub stringClient Secret Setting Name - The app setting name that contains the client secret of the Github app used for GitHub Login.
- Git
Hub []stringOAuth Scopes - The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. This setting is optional
- Google
Client stringId - The OpenID Connect Client ID for the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/
- Google
Client stringSecret - The client secret associated with the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/
- Google
Client stringSecret Setting Name - The app setting name that contains the client secret associated with the Google web application.
- Google
OAuth []stringScopes - The OAuth 2.0 scopes that will be requested as 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: https://developers.google.com/identity/sign-in/web/
- Is
Auth stringFrom File - "true" if the auth config settings should be read from a file, "false" otherwise
- Issuer string
- The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html
- Kind string
- Kind of resource.
- Microsoft
Account stringClient Id - The OAuth 2.0 client ID that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm
- Microsoft
Account stringClient Secret - The OAuth 2.0 client secret that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm
- Microsoft
Account stringClient Secret Setting Name - The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication.
- Microsoft
Account []stringOAuth Scopes - The OAuth 2.0 scopes that will be requested as 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: https://msdn.microsoft.com/en-us/library/dn631845.aspx
- Runtime
Version string - The RuntimeVersion of the Authentication / 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.
- Token
Refresh float64Extension Hours - The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours.
- Token
Store boolEnabled - true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. The default is false.
- Twitter
Consumer stringKey - The OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in
- Twitter
Consumer stringSecret - The OAuth 1.0a consumer secret of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in
- Twitter
Consumer stringSecret Setting Name - The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.
- Unauthenticated
Client stringAction - The action to take when an unauthenticated client attempts to access the app.
- Validate
Issuer bool - Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such.
- id String
- Resource Id.
- name String
- Resource Name.
- type String
- Resource type.
- String
- Gets a JSON string containing the Azure AD Acl settings.
- additional
Login List<String>Params - Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value".
- allowed
Audiences List<String> - Allowed audience values to consider when validating JSON Web Tokens issued by Azure Active Directory. Note that the ClientID value is always considered an allowed audience, regardless of this setting.
- allowed
External List<String>Redirect Urls - External URLs that can be redirected to as part 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.
- auth
File StringPath - The path of the config file containing auth settings. If the path is relative, base will the site's root directory.
- client
Id String - The Client ID of this relying party application, known 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: http://openid.net/specs/openid-connect-core-1_0.html
- client
Secret String - The Client Secret of this relying party application (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: http://openid.net/specs/openid-connect-core-1_0.html
- client
Secret StringCertificate Thumbprint - An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as a replacement for the Client Secret. It is also optional.
- client
Secret StringSetting Name - The app setting name that contains the client secret of the relying party application.
- config
Version String - The ConfigVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of the control plane for Authentication / Authorization.
- default
Provider String - The default authentication 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".
- enabled Boolean
- true if the Authentication / Authorization feature is enabled for the current app; otherwise, false.
- facebook
App StringId - The App ID of the Facebook app used for login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
- facebook
App StringSecret - The App Secret of the Facebook app used for Facebook Login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
- facebook
App StringSecret Setting Name - The app setting name that contains the app secret used for Facebook Login.
- facebook
OAuth List<String>Scopes - The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication. This setting is optional. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
- git
Hub StringClient Id - The Client Id of the GitHub app used for login. This setting is required for enabling Github login
- git
Hub StringClient Secret - The Client Secret of the GitHub app used for Github Login. This setting is required for enabling Github login.
- git
Hub StringClient Secret Setting Name - The app setting name that contains the client secret of the Github app used for GitHub Login.
- git
Hub List<String>OAuth Scopes - The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. This setting is optional
- google
Client StringId - The OpenID Connect Client ID for the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/
- google
Client StringSecret - The client secret associated with the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/
- google
Client StringSecret Setting Name - The app setting name that contains the client secret associated with the Google web application.
- google
OAuth List<String>Scopes - The OAuth 2.0 scopes that will be requested as 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: https://developers.google.com/identity/sign-in/web/
- is
Auth StringFrom File - "true" if the auth config settings should be read from a file, "false" otherwise
- issuer String
- The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html
- kind String
- Kind of resource.
- microsoft
Account StringClient Id - The OAuth 2.0 client ID that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm
- microsoft
Account StringClient Secret - The OAuth 2.0 client secret that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm
- microsoft
Account StringClient Secret Setting Name - The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication.
- microsoft
Account List<String>OAuth Scopes - The OAuth 2.0 scopes that will be requested as 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: https://msdn.microsoft.com/en-us/library/dn631845.aspx
- runtime
Version String - The RuntimeVersion of the Authentication / 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.
- token
Refresh DoubleExtension Hours - The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours.
- token
Store BooleanEnabled - true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. The default is false.
- twitter
Consumer StringKey - The OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in
- twitter
Consumer StringSecret - The OAuth 1.0a consumer secret of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in
- twitter
Consumer StringSecret Setting Name - The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.
- unauthenticated
Client StringAction - The action to take when an unauthenticated client attempts to access the app.
- validate
Issuer Boolean - Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such.
- id string
- Resource Id.
- name string
- Resource Name.
- type string
- Resource type.
- string
- Gets a JSON string containing the Azure AD Acl settings.
- additional
Login string[]Params - Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value".
- allowed
Audiences string[] - Allowed audience values to consider when validating JSON Web Tokens issued by Azure Active Directory. Note that the ClientID value is always considered an allowed audience, regardless of this setting.
- allowed
External string[]Redirect Urls - External URLs that can be redirected to as part 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.
- auth
File stringPath - The path of the config file containing auth settings. If the path is relative, base will the site's root directory.
- client
Id string - The Client ID of this relying party application, known 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: http://openid.net/specs/openid-connect-core-1_0.html
- client
Secret string - The Client Secret of this relying party application (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: http://openid.net/specs/openid-connect-core-1_0.html
- client
Secret stringCertificate Thumbprint - An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as a replacement for the Client Secret. It is also optional.
- client
Secret stringSetting Name - The app setting name that contains the client secret of the relying party application.
- config
Version string - The ConfigVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of the control plane for Authentication / Authorization.
- default
Provider string - The default authentication 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".
- enabled boolean
- true if the Authentication / Authorization feature is enabled for the current app; otherwise, false.
- facebook
App stringId - The App ID of the Facebook app used for login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
- facebook
App stringSecret - The App Secret of the Facebook app used for Facebook Login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
- facebook
App stringSecret Setting Name - The app setting name that contains the app secret used for Facebook Login.
- facebook
OAuth string[]Scopes - The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication. This setting is optional. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
- git
Hub stringClient Id - The Client Id of the GitHub app used for login. This setting is required for enabling Github login
- git
Hub stringClient Secret - The Client Secret of the GitHub app used for Github Login. This setting is required for enabling Github login.
- git
Hub stringClient Secret Setting Name - The app setting name that contains the client secret of the Github app used for GitHub Login.
- git
Hub string[]OAuth Scopes - The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. This setting is optional
- google
Client stringId - The OpenID Connect Client ID for the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/
- google
Client stringSecret - The client secret associated with the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/
- google
Client stringSecret Setting Name - The app setting name that contains the client secret associated with the Google web application.
- google
OAuth string[]Scopes - The OAuth 2.0 scopes that will be requested as 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: https://developers.google.com/identity/sign-in/web/
- is
Auth stringFrom File - "true" if the auth config settings should be read from a file, "false" otherwise
- issuer string
- The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html
- kind string
- Kind of resource.
- microsoft
Account stringClient Id - The OAuth 2.0 client ID that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm
- microsoft
Account stringClient Secret - The OAuth 2.0 client secret that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm
- microsoft
Account stringClient Secret Setting Name - The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication.
- microsoft
Account string[]OAuth Scopes - The OAuth 2.0 scopes that will be requested as 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: https://msdn.microsoft.com/en-us/library/dn631845.aspx
- runtime
Version string - The RuntimeVersion of the Authentication / 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.
- token
Refresh numberExtension Hours - The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours.
- token
Store booleanEnabled - true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. The default is false.
- twitter
Consumer stringKey - The OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in
- twitter
Consumer stringSecret - The OAuth 1.0a consumer secret of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in
- twitter
Consumer stringSecret Setting Name - The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.
- unauthenticated
Client stringAction - The action to take when an unauthenticated client attempts to access the app.
- validate
Issuer boolean - Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such.
- id str
- Resource Id.
- name str
- Resource Name.
- type str
- Resource type.
- str
- Gets a JSON string containing the Azure AD Acl settings.
- additional_
login_ Sequence[str]params - Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value".
- allowed_
audiences Sequence[str] - Allowed audience values to consider when validating JSON Web Tokens issued by Azure Active Directory. Note that the ClientID value is always considered an allowed audience, regardless of this setting.
- allowed_
external_ Sequence[str]redirect_ urls - External URLs that can be redirected to as part 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.
- auth_
file_ strpath - The path of the config file containing auth settings. If the path is relative, base will the site's root directory.
- client_
id str - The Client ID of this relying party application, known 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: http://openid.net/specs/openid-connect-core-1_0.html
- client_
secret str - The Client Secret of this relying party application (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: http://openid.net/specs/openid-connect-core-1_0.html
- client_
secret_ strcertificate_ thumbprint - An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as a replacement for the Client Secret. It is also optional.
- client_
secret_ strsetting_ name - The app setting name that contains the client secret of the relying party application.
- config_
version str - The ConfigVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of the control plane for Authentication / Authorization.
- default_
provider str - The default authentication 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".
- enabled bool
- true if the Authentication / Authorization feature is enabled for the current app; otherwise, false.
- facebook_
app_ strid - The App ID of the Facebook app used for login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
- facebook_
app_ strsecret - The App Secret of the Facebook app used for Facebook Login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
- facebook_
app_ strsecret_ setting_ name - The app setting name that contains the app secret used for Facebook Login.
- facebook_
o_ Sequence[str]auth_ scopes - The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication. This setting is optional. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
- git_
hub_ strclient_ id - The Client Id of the GitHub app used for login. This setting is required for enabling Github login
- git_
hub_ strclient_ secret - The Client Secret of the GitHub app used for Github Login. This setting is required for enabling Github login.
- git_
hub_ strclient_ secret_ setting_ name - The app setting name that contains the client secret of the Github app used for GitHub Login.
- git_
hub_ Sequence[str]o_ auth_ scopes - The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. This setting is optional
- google_
client_ strid - The OpenID Connect Client ID for the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/
- google_
client_ strsecret - The client secret associated with the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/
- google_
client_ strsecret_ setting_ name - The app setting name that contains the client secret associated with the Google web application.
- google_
o_ Sequence[str]auth_ scopes - The OAuth 2.0 scopes that will be requested as 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: https://developers.google.com/identity/sign-in/web/
- is_
auth_ strfrom_ file - "true" if the auth config settings should be read from a file, "false" otherwise
- issuer str
- The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html
- kind str
- Kind of resource.
- microsoft_
account_ strclient_ id - The OAuth 2.0 client ID that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm
- microsoft_
account_ strclient_ secret - The OAuth 2.0 client secret that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm
- microsoft_
account_ strclient_ secret_ setting_ name - The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication.
- microsoft_
account_ Sequence[str]o_ auth_ scopes - The OAuth 2.0 scopes that will be requested as 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: https://msdn.microsoft.com/en-us/library/dn631845.aspx
- runtime_
version str - The RuntimeVersion of the Authentication / 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.
- token_
refresh_ floatextension_ hours - The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours.
- token_
store_ boolenabled - true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. The default is false.
- twitter_
consumer_ strkey - The OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in
- twitter_
consumer_ strsecret - The OAuth 1.0a consumer secret of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in
- twitter_
consumer_ strsecret_ setting_ name - The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.
- unauthenticated_
client_ straction - The action to take when an unauthenticated client attempts to access the app.
- validate_
issuer bool - Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such.
- id String
- Resource Id.
- name String
- Resource Name.
- type String
- Resource type.
- String
- Gets a JSON string containing the Azure AD Acl settings.
- additional
Login List<String>Params - Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value".
- allowed
Audiences List<String> - Allowed audience values to consider when validating JSON Web Tokens issued by Azure Active Directory. Note that the ClientID value is always considered an allowed audience, regardless of this setting.
- allowed
External List<String>Redirect Urls - External URLs that can be redirected to as part 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.
- auth
File StringPath - The path of the config file containing auth settings. If the path is relative, base will the site's root directory.
- client
Id String - The Client ID of this relying party application, known 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: http://openid.net/specs/openid-connect-core-1_0.html
- client
Secret String - The Client Secret of this relying party application (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: http://openid.net/specs/openid-connect-core-1_0.html
- client
Secret StringCertificate Thumbprint - An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as a replacement for the Client Secret. It is also optional.
- client
Secret StringSetting Name - The app setting name that contains the client secret of the relying party application.
- config
Version String - The ConfigVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of the control plane for Authentication / Authorization.
- default
Provider String - The default authentication 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".
- enabled Boolean
- true if the Authentication / Authorization feature is enabled for the current app; otherwise, false.
- facebook
App StringId - The App ID of the Facebook app used for login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
- facebook
App StringSecret - The App Secret of the Facebook app used for Facebook Login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
- facebook
App StringSecret Setting Name - The app setting name that contains the app secret used for Facebook Login.
- facebook
OAuth List<String>Scopes - The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication. This setting is optional. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
- git
Hub StringClient Id - The Client Id of the GitHub app used for login. This setting is required for enabling Github login
- git
Hub StringClient Secret - The Client Secret of the GitHub app used for Github Login. This setting is required for enabling Github login.
- git
Hub StringClient Secret Setting Name - The app setting name that contains the client secret of the Github app used for GitHub Login.
- git
Hub List<String>OAuth Scopes - The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. This setting is optional
- google
Client StringId - The OpenID Connect Client ID for the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/
- google
Client StringSecret - The client secret associated with the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/
- google
Client StringSecret Setting Name - The app setting name that contains the client secret associated with the Google web application.
- google
OAuth List<String>Scopes - The OAuth 2.0 scopes that will be requested as 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: https://developers.google.com/identity/sign-in/web/
- is
Auth StringFrom File - "true" if the auth config settings should be read from a file, "false" otherwise
- issuer String
- The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html
- kind String
- Kind of resource.
- microsoft
Account StringClient Id - The OAuth 2.0 client ID that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm
- microsoft
Account StringClient Secret - The OAuth 2.0 client secret that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm
- microsoft
Account StringClient Secret Setting Name - The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication.
- microsoft
Account List<String>OAuth Scopes - The OAuth 2.0 scopes that will be requested as 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: https://msdn.microsoft.com/en-us/library/dn631845.aspx
- runtime
Version String - The RuntimeVersion of the Authentication / 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.
- token
Refresh NumberExtension Hours - The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours.
- token
Store BooleanEnabled - true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. The default is false.
- twitter
Consumer StringKey - The OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in
- twitter
Consumer StringSecret - The OAuth 1.0a consumer secret of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in
- twitter
Consumer StringSecret Setting Name - The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.
- unauthenticated
Client StringAction - The action to take when an unauthenticated client attempts to access the app.
- validate
Issuer Boolean - Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi