PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings/?api-version=2023-01-01

Description for Updates the Authentication / Authorization settings associated with web app.

Servers

https://management.azure.com/

Path parameters

Name	Type	Required	Description
`name`	String	Yes	Name of web app.
`subscriptionId`	String	Yes	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
`resourceGroupName`	String	Yes	Name of the resource group to which the resource belongs.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`id`	String	No	Resource Id.
`name`	String	No	Resource Name.
`properties`	Object	No	SiteAuthSettings resource specific properties
`properties.allowedAudiences[]`	Array	No	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.
`properties.microsoftAccountClientSecretSettingName`	String	No	The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication.
`properties.googleClientId`	String	No	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/
`properties.tokenRefreshExtensionHours`	Number	No	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.
`properties.twitterConsumerSecretSettingName`	String	No	The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.
`properties.tokenStoreEnabled`	Boolean	No	`true` to durably store platform-specific security tokens that are obtained during login flows; otherwise, `false`. The default is `false`.
`properties.gitHubClientSecret`	String	No	The Client Secret of the GitHub app used for Github Login. This setting is required for enabling Github login.
`properties.clientSecretCertificateThumbprint`	String	No	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.
`properties.aadClaimsAuthorization`	String	No	Gets a JSON string containing the Azure AD Acl settings.
`properties.clientSecret`	String	No	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
`properties.twitterConsumerSecret`	String	No	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
`properties.unauthenticatedClientAction`	String	No	The action to take when an unauthenticated client attempts to access the app. Possible values: `"RedirectToLoginPage"` `"AllowAnonymous"`
`properties.gitHubClientSecretSettingName`	String	No	The app setting name that contains the client secret of the Github app used for GitHub Login.
`properties.validateIssuer`	Boolean	No	Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such.
`properties.gitHubClientId`	String	No	The Client Id of the GitHub app used for login. This setting is required for enabling Github login
`properties.authFilePath`	String	No	The path of the config file containing auth settings. If the path is relative, base will the site's root directory.
`properties.facebookAppSecret`	String	No	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
`properties.twitterConsumerKey`	String	No	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
`properties.issuer`	String	No	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
`properties.googleClientSecret`	String	No	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/
`properties.facebookAppId`	String	No	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
`properties.gitHubOAuthScopes[]`	Array	No	The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. This setting is optional
`properties.clientId`	String	No	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
`properties.clientSecretSettingName`	String	No	The app setting name that contains the client secret of the relying party application.
`properties.additionalLoginParams[]`	Array	No	Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value".
`properties.googleOAuthScopes[]`	Array	No	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/
`properties.isAuthFromFile`	String	No	"true" if the auth config settings should be read from a file, "false" otherwise
`properties.googleClientSecretSettingName`	String	No	The app setting name that contains the client secret associated with the Google web application.
`properties.microsoftAccountOAuthScopes[]`	Array	No	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
`properties.microsoftAccountClientId`	String	No	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
`properties.microsoftAccountClientSecret`	String	No	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
`properties.allowedExternalRedirectUrls[]`	Array	No	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.
`properties.runtimeVersion`	String	No	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.
`properties.enabled`	Boolean	No	`true` if the Authentication / Authorization feature is enabled for the current app; otherwise, `false`.
`properties.configVersion`	String	No	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.
`properties.facebookAppSecretSettingName`	String	No	The app setting name that contains the app secret used for Facebook Login.
`properties.defaultProvider`	String	No	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". Possible values: `"Twitter"` `"MicrosoftAccount"` `"AzureActiveDirectory"` `"Facebook"` `"Google"` `"Github"`
`properties.facebookOAuthScopes[]`	Array	No	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
`type`	String	No	Resource type.
`kind`	String	No	Kind of resource.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.