Web Apps - Get Auth Settings

  • Referensi
Service:
App Service
API Version:
2021-02-01

Mendapatkan pengaturan Autentikasi/Otorisasi aplikasi.

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

Parameter URI

Name In Required Type Description
name
 path True
  • string

Nama aplikasi.
resourceGroupName
 path True
  • string

Nama grup sumber daya tempat sumber daya berada.

Regex pattern: ^[-\w\._\(\)]+[^\.]$
subscriptionId
 path True
  • string

ID langganan Azure Anda. Ini adalah string berformat GUID (misalnya 000000000-0000-0000-0000-00000000000).
api-version
 query True
  • string

Versi API

Respons

Name Type Description
200 OK

OK
Other Status Codes

App Service respons kesalahan.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation meniru akun pengguna Anda

Definisi

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".

Name Type Description
AzureActiveDirectory
  • string
Facebook
  • string
Github
  • string
Google
  • string
MicrosoftAccount
  • string
Twitter
  • string

DefaultErrorResponse

App Service respons kesalahan.

Name Type Description
error

Model kesalahan.

Details

Name Type Description
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.

Name Type Description
code
  • string

String standar untuk mengidentifikasi kesalahan secara terprogram.
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.

Name Type Description
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 Koneksi OpenID saat pengguna masuk. Setiap parameter harus dalam bentuk "key=value".
properties.allowedAudiences
  • string[]

Nilai audiens yang diizinkan untuk dipertimbangkan saat memvalidasi JWT 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 Koneksi OpenID pihak ke-3 lainnya. Informasi selengkapnya tentang Koneksi OpenID:http://openid.net/specs/openid-connect-core-1_0.html
properties.clientSecret
  • string

Rahasia Klien dari aplikasi pihak yang mengandalkan ini (dalam Azure Active Directory, ini juga disebut sebagai Kunci). Pengaturan ini bersifat opsional. Jika tidak ada rahasia klien yang dikonfigurasi, alur autentikasi implisit Koneksi OpenID digunakan untuk mengautentikasi pengguna akhir. Jika tidak, OpenID Koneksi Authorization Code Flow digunakan untuk mengautentikasi pengguna akhir. Informasi selengkapnya tentang Koneksi OpenID: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

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 aplikasi Facebook yang digunakan untuk masuk. Pengaturan ini diperlukan untuk mengaktifkan Login Facebook. Dokumentasi Masuk Facebook: https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecret
  • string

Rahasia Aplikasi aplikasi Facebook yang digunakan untuk Masuk Facebook. Pengaturan ini diperlukan untuk mengaktifkan Login Facebook. Dokumentasi Masuk Facebook: https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecretSettingName
  • string

Nama pengaturan aplikasi yang berisi rahasia aplikasi yang digunakan untuk Masuk Facebook.
properties.facebookOAuthScopes
  • string[]

Cakupan OAuth 2.0 yang akan diminta sebagai bagian dari autentikasi Masuk Facebook. Pengaturan ini bersifat opsional. Dokumentasi Masuk 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 GitHub Login. Pengaturan ini bersifat opsional
properties.googleClientId
  • string

ID Klien Koneksi OpenID 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 auth harus dibaca dari file, "false" jika tidak
properties.issuer
  • string

OpenID Koneksi Issuer URI 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 OpenID Koneksi Discovery: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. Defaultnya 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

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.

Name Type Description
AllowAnonymous
  • string
RedirectToLoginPage
  • string