Web Apps - Get Auth Settings

Referensi

Layanan:: App Service

Versi API:: 2023-12-01

Deskripsi untuk Mendapatkan pengaturan Autentikasi/Otorisasi aplikasi.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings/list?api-version=2023-12-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
name	path	True	string	Nama aplikasi.
resourceGroupName	path	True	string	Nama grup sumber daya tempat sumber daya berada. Pola regex: `^[-\w\._\(\)]+[^\.]$`
subscriptionId	path	True	string	ID langganan Azure Anda. Ini adalah string berformat GUID (misalnya 000000000-0000-0000-0000-000000000000).
api-version	query	True	string	Versi API

Respons

Nama	Jenis	Deskripsi
200 OK	SiteAuthSettings	OK
Other Status Codes	DefaultErrorResponse	App Service respons kesalahan.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

List Auth Settings

Permintaan sampel

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/authsettings/list?api-version=2023-12-01


/**
 * Samples for WebApps GetAuthSettings.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/ListAuthSettings.json
     */
    /**
     * Sample code: List Auth Settings.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listAuthSettings(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWebApps().getAuthSettingsWithResponse("testrg123", "sitef6141",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python list_auth_settings.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = WebSiteManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    response = client.web_apps.get_auth_settings(
        resource_group_name="testrg123",
        name="sitef6141",
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/ListAuthSettings.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v4"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/21c2852d62ccc3abe9cc3800c989c6826f8363dc/specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/ListAuthSettings.json
func ExampleWebAppsClient_GetAuthSettings() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWebAppsClient().GetAuthSettings(ctx, "testrg123", "sitef6141", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SiteAuthSettings = armappservice.SiteAuthSettings{
	// 	Name: to.Ptr("authsettings"),
	// 	Type: to.Ptr("Microsoft.Web/sites/authsettings"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/authsettings"),
	// 	Kind: to.Ptr("app"),
	// 	Properties: &armappservice.SiteAuthSettingsProperties{
	// 		AllowedExternalRedirectUrls: []*string{
	// 			to.Ptr("sitef6141.customdomain.net"),
	// 			to.Ptr("sitef6141.customdomain.info")},
	// 			ClientID: to.Ptr("42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com"),
	// 			DefaultProvider: to.Ptr(armappservice.BuiltInAuthenticationProviderGoogle),
	// 			Enabled: to.Ptr(true),
	// 			RuntimeVersion: to.Ptr("~1"),
	// 			TokenRefreshExtensionHours: to.Ptr[float64](120),
	// 			TokenStoreEnabled: to.Ptr(true),
	// 			UnauthenticatedClientAction: to.Ptr(armappservice.UnauthenticatedClientActionRedirectToLoginPage),
	// 		},
	// 	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Description for Gets the Authentication/Authorization settings of an app.
 *
 * @summary Description for Gets the Authentication/Authorization settings of an app.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/ListAuthSettings.json
 */
async function listAuthSettings() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "testrg123";
  const name = "sitef6141";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.webApps.getAuthSettings(resourceGroupName, name);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/ListAuthSettings.json
// this example is just showing the usage of "WebApps_GetAuthSettings" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this WebSiteResource created on azure
// for more information of creating WebSiteResource, please refer to the document of WebSiteResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "testrg123";
string name = "sitef6141";
ResourceIdentifier webSiteResourceId = WebSiteResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
WebSiteResource webSite = client.GetWebSiteResource(webSiteResourceId);

// invoke the operation
SiteAuthSettings result = await webSite.GetAuthSettingsAsync();

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respon sampel

Kode status:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/authsettings",
  "name": "authsettings",
  "type": "Microsoft.Web/sites/authsettings",
  "kind": "app",
  "properties": {
    "enabled": true,
    "runtimeVersion": "~1",
    "unauthenticatedClientAction": "RedirectToLoginPage",
    "tokenStoreEnabled": true,
    "allowedExternalRedirectUrls": [
      "sitef6141.customdomain.net",
      "sitef6141.customdomain.info"
    ],
    "defaultProvider": "Google",
    "tokenRefreshExtensionHours": 120,
    "clientId": "42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com"
  }
}

Definisi

Nama	Deskripsi
BuiltInAuthenticationProvider	Penyedia autentikasi default untuk digunakan saat beberapa penyedia dikonfigurasi. Pengaturan ini hanya diperlukan jika beberapa penyedia dikonfigurasi dan tindakan klien yang tidak diautentikasi diatur ke "RedirectToLoginPage".
DefaultErrorResponse	App Service respons kesalahan.
Details
Error	Model kesalahan.
SiteAuthSettings	Pengaturan konfigurasi untuk fitur Autentikasi/Otorisasi Azure App Service.
UnauthenticatedClientAction	Tindakan yang harus diambil ketika klien yang tidak diaauthenticated mencoba mengakses aplikasi.

BuiltInAuthenticationProvider

Penyedia autentikasi default untuk digunakan saat beberapa penyedia dikonfigurasi. Pengaturan ini hanya diperlukan jika beberapa penyedia dikonfigurasi dan tindakan klien yang tidak diautentikasi diatur ke "RedirectToLoginPage".

Nama	Jenis	Deskripsi
AzureActiveDirectory	string
Facebook	string
Github	string
Google	string
MicrosoftAccount	string
Twitter	string

DefaultErrorResponse

App Service respons kesalahan.

Nama	Jenis	Deskripsi
error	Error	Model kesalahan.

Details

Nama	Jenis	Deskripsi
code	string	String standar untuk mengidentifikasi kesalahan secara terprogram.
message	string	Deskripsi kesalahan terperinci dan informasi penelusuran kesalahan.
target	string	Deskripsi kesalahan terperinci dan informasi penelusuran kesalahan.

Error

Model kesalahan.

Nama	Jenis	Deskripsi
code	string	String standar untuk mengidentifikasi kesalahan secara terprogram.
details	Details[]	Kesalahan terperinci.
innererror	string	Informasi selengkapnya untuk men-debug kesalahan.
message	string	Deskripsi kesalahan terperinci dan informasi penelusuran kesalahan.
target	string	Deskripsi kesalahan terperinci dan informasi penelusuran kesalahan.

SiteAuthSettings

Pengaturan konfigurasi untuk fitur Autentikasi/Otorisasi Azure App Service.

Nama	Jenis	Deskripsi
id	string	Id Sumber Daya.
kind	string	Jenis sumber daya.
name	string	Nama Sumber Daya.
properties.aadClaimsAuthorization	string	Mendapatkan string JSON yang berisi pengaturan Acl Azure AD.
properties.additionalLoginParams	string[]	Parameter login untuk dikirim ke titik akhir otorisasi OpenID Connect saat pengguna masuk. Setiap parameter harus dalam bentuk "key=value".
properties.allowedAudiences	string[]	Nilai audiens yang diizinkan untuk dipertimbangkan saat memvalidasi JSON Web Token yang dikeluarkan oleh Azure Active Directory. Perhatikan bahwa `ClientID` nilai selalu dianggap sebagai audiens yang diizinkan, terlepas dari pengaturan ini.
properties.allowedExternalRedirectUrls	string[]	URL eksternal yang dapat dialihkan sebagai bagian dari masuk atau keluar dari aplikasi. Perhatikan bahwa bagian string kueri url diabaikan. Ini adalah pengaturan tingkat lanjut biasanya hanya diperlukan oleh backend aplikasi Windows Store. Perhatikan bahwa URL dalam domain saat ini selalu diizinkan secara implisit.
properties.authFilePath	string	Jalur file konfigurasi yang berisi pengaturan auth. Jika jalur relatif, basis akan direktori akar situs.
properties.clientId	string	ID Klien dari aplikasi pihak yang mengandalkan ini, yang dikenal sebagai client_id. Pengaturan ini diperlukan untuk mengaktifkan autentikasi Koneksi OpenID dengan Azure Active Directory atau penyedia OpenID Connect pihak ke-3 lainnya. Informasi selengkapnya tentang OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
properties.clientSecret	string	Rahasia Klien dari aplikasi pihak yang mengandalkan ini (di Azure Active Directory, ini juga disebut sebagai Kunci). Pengaturan ini bersifat opsional. Jika tidak ada rahasia klien yang dikonfigurasi, alur autentikasi implisit OpenID Connect digunakan untuk mengautentikasi pengguna akhir. Jika tidak, Alur Kode Otorisasi OpenID Connect digunakan untuk mengautentikasi pengguna akhir. Informasi selengkapnya tentang OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
properties.clientSecretCertificateThumbprint	string	Alternatif untuk rahasia klien, yaitu thumbprint sertifikat yang digunakan untuk tujuan penandatanganan. Properti ini bertindak sebagai pengganti Rahasia Klien. Ini juga opsional.
properties.clientSecretSettingName	string	Nama pengaturan aplikasi yang berisi rahasia klien dari aplikasi pihak yang mengandalkan.
properties.configVersion	string	ConfigVersion fitur Autentikasi/ Otorisasi yang digunakan untuk aplikasi saat ini. Pengaturan dalam nilai ini dapat mengontrol perilaku sarana kontrol untuk Autentikasi / Otorisasi.
properties.defaultProvider	BuiltInAuthenticationProvider	Penyedia autentikasi default untuk digunakan saat beberapa penyedia dikonfigurasi. Pengaturan ini hanya diperlukan jika beberapa penyedia dikonfigurasi dan tindakan klien yang tidak diautentikasi diatur ke "RedirectToLoginPage".
properties.enabled	boolean	`true` jika fitur Autentikasi/ Otorisasi diaktifkan untuk aplikasi saat ini; jika tidak, `false`.
properties.facebookAppId	string	ID Aplikasi dari aplikasi Facebook yang digunakan untuk masuk. Pengaturan ini diperlukan untuk mengaktifkan Facebook Masuk. dokumentasi login Facebook:https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecret	string	Rahasia Aplikasi dari aplikasi Facebook yang digunakan untuk Facebook Login. Pengaturan ini diperlukan untuk mengaktifkan Facebook Masuk. dokumentasi login Facebook:https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecretSettingName	string	Nama pengaturan aplikasi yang berisi rahasia aplikasi yang digunakan untuk Facebook Login.
properties.facebookOAuthScopes	string[]	Cakupan OAuth 2.0 yang akan diminta sebagai bagian dari autentikasi Facebook Login. Pengaturan ini bersifat opsional. dokumentasi login Facebook:https://developers.facebook.com/docs/facebook-login
properties.gitHubClientId	string	Id Klien aplikasi GitHub yang digunakan untuk masuk. Pengaturan ini diperlukan untuk mengaktifkan login Github
properties.gitHubClientSecret	string	Rahasia Klien aplikasi GitHub yang digunakan untuk Masuk Github. Pengaturan ini diperlukan untuk mengaktifkan masuk Github.
properties.gitHubClientSecretSettingName	string	Nama pengaturan aplikasi yang berisi rahasia klien aplikasi Github yang digunakan untuk GitHub Login.
properties.gitHubOAuthScopes	string[]	Cakupan OAuth 2.0 yang akan diminta sebagai bagian dari autentikasi Masuk GitHub. Pengaturan ini bersifat opsional
properties.googleClientId	string	ID Klien OpenID Connect untuk aplikasi web Google. Pengaturan ini diperlukan untuk mengaktifkan Masuk Google. Dokumentasi Google Sign-In: https://developers.google.com/identity/sign-in/web/
properties.googleClientSecret	string	Rahasia klien yang terkait dengan aplikasi web Google. Pengaturan ini diperlukan untuk mengaktifkan Masuk Google. Dokumentasi Google Sign-In: https://developers.google.com/identity/sign-in/web/
properties.googleClientSecretSettingName	string	Nama pengaturan aplikasi yang berisi rahasia klien yang terkait dengan aplikasi web Google.
properties.googleOAuthScopes	string[]	Cakupan OAuth 2.0 yang akan diminta sebagai bagian dari autentikasi Google Sign-In. Pengaturan ini bersifat opsional. Jika tidak ditentukan, "openid", "profile", dan "email" digunakan sebagai cakupan default. Dokumentasi Google Sign-In: https://developers.google.com/identity/sign-in/web/
properties.isAuthFromFile	string	"true" jika pengaturan konfigurasi autentikasi harus dibaca dari file, "false" jika tidak
properties.issuer	string	URI Penerbit OpenID Connect yang mewakili entitas yang mengeluarkan token akses untuk aplikasi ini. Saat menggunakan Azure Active Directory, nilai ini adalah URI penyewa direktori, misalnya https://sts.windows.net/{tenant-guid}/. URI ini adalah pengidentifikasi peka huruf besar/kecil untuk penerbit token. Informasi selengkapnya tentang Penemuan OpenID Connect: http://openid.net/specs/openid-connect-discovery-1_0.html
properties.microsoftAccountClientId	string	ID klien OAuth 2.0 yang dibuat untuk aplikasi yang digunakan untuk autentikasi. Pengaturan ini diperlukan untuk mengaktifkan autentikasi Akun Microsoft. Dokumentasi OAuth Akun Microsoft: https://dev.onedrive.com/auth/msa_oauth.htm
properties.microsoftAccountClientSecret	string	Rahasia klien OAuth 2.0 yang dibuat untuk aplikasi yang digunakan untuk autentikasi. Pengaturan ini diperlukan untuk mengaktifkan autentikasi Akun Microsoft. Dokumentasi OAuth Akun Microsoft: https://dev.onedrive.com/auth/msa_oauth.htm
properties.microsoftAccountClientSecretSettingName	string	Nama pengaturan aplikasi yang berisi rahasia klien OAuth 2.0 yang dibuat untuk aplikasi yang digunakan untuk autentikasi.
properties.microsoftAccountOAuthScopes	string[]	Cakupan OAuth 2.0 yang akan diminta sebagai bagian dari autentikasi Akun Microsoft. Pengaturan ini bersifat opsional. Jika tidak ditentukan, "wl.basic" digunakan sebagai cakupan default. Dokumentasi Cakupan dan izin Akun Microsoft: https://msdn.microsoft.com/en-us/library/dn631845.aspx
properties.runtimeVersion	string	RuntimeVersion fitur Autentikasi/ Otorisasi yang digunakan untuk aplikasi saat ini. Pengaturan dalam nilai ini dapat mengontrol perilaku fitur tertentu dalam modul Autentikasi / Otorisasi.
properties.tokenRefreshExtensionHours	number	Jumlah jam setelah kedaluwarsa token sesi yang dapat digunakan token sesi untuk memanggil API refresh token. Defaultnya adalah 72 jam.
properties.tokenStoreEnabled	boolean	`true` untuk menyimpan token keamanan khusus platform yang diperoleh selama alur masuk; jika tidak, `false`. Default adalah `false`.
properties.twitterConsumerKey	string	Kunci konsumen OAuth 1.0a dari aplikasi Twitter yang digunakan untuk masuk. Pengaturan ini diperlukan untuk mengaktifkan Masuk Twitter. Dokumentasi Sign-In Twitter: https://dev.twitter.com/web/sign-in
properties.twitterConsumerSecret	string	Rahasia konsumen OAuth 1.0a dari aplikasi Twitter yang digunakan untuk masuk. Pengaturan ini diperlukan untuk mengaktifkan Masuk Twitter. Dokumentasi Sign-In Twitter: https://dev.twitter.com/web/sign-in
properties.twitterConsumerSecretSettingName	string	Nama pengaturan aplikasi yang berisi rahasia konsumen OAuth 1.0a dari aplikasi Twitter yang digunakan untuk masuk.
properties.unauthenticatedClientAction	UnauthenticatedClientAction	Tindakan yang harus diambil ketika klien yang tidak diaauthenticated mencoba mengakses aplikasi.
properties.validateIssuer	boolean	Mendapatkan nilai yang menunjukkan apakah penerbit harus menjadi url HTTPS yang valid dan divalidasi seperti itu.
type	string	Jenis sumber daya

UnauthenticatedClientAction

Tindakan yang harus diambil ketika klien yang tidak diaauthenticated mencoba mengakses aplikasi.

Nama	Jenis	Deskripsi
AllowAnonymous	string
RedirectToLoginPage	string