Bagikan melalui

AuthorizationServerUpdateContract interface

Paket:
@azure/arm-apimanagement

Pengaturan server otorisasi OAuth eksternal.

Memperluas
ProxyResource

Properti

authorizationEndpoint

Titik akhir otorisasi OAuth. Lihat http://tools.ietf.org/html/rfc6749#section-3.2.
authorizationMethods

Kata kerja HTTP didukung oleh titik akhir otorisasi. GET harus selalu ada. POST bersifat opsional.
bearerTokenSendingMethods

Menentukan mekanisme di mana token akses diteruskan ke API.
clientAuthenticationMethod

Metode autentikasi yang didukung oleh titik akhir token server otorisasi ini. Nilai yang mungkin adalah Dasar dan/atau Isi. Ketika Isi ditentukan, kredensial klien dan parameter lain diteruskan dalam isi permintaan dalam format application/x-www-form-urlencoded.
clientId

Id klien atau aplikasi yang terdaftar di server otorisasi ini.
clientRegistrationEndpoint

Referensi opsional ke halaman tempat pendaftaran klien atau aplikasi untuk server otorisasi ini dilakukan. Berisi URL absolut ke entitas yang dirujuk.
clientSecret

Rahasia klien atau aplikasi yang terdaftar di server otorisasi ini. Properti ini tidak akan diisi pada operasi 'GET'! Gunakan permintaan POST '/listSecrets' untuk mendapatkan nilainya.
defaultScope

Cakupan token akses yang akan diminta secara default. Dapat ditimpa di tingkat API. Harus disediakan dalam bentuk string yang berisi nilai yang dibatasi spasi.
description

Deskripsi server otorisasi. Dapat berisi tag pemformatan HTML.
displayName

Nama server otorisasi yang mudah digunakan.
grantTypes

Bentuk pemberian otorisasi, yang digunakan klien untuk meminta token akses.
resourceOwnerPassword

Dapat ditentukan secara opsional ketika jenis pemberian kata sandi pemilik sumber daya didukung oleh server otorisasi ini. Kata sandi pemilik sumber daya default.
resourceOwnerUsername

Dapat ditentukan secara opsional ketika jenis pemberian kata sandi pemilik sumber daya didukung oleh server otorisasi ini. Nama pengguna pemilik sumber daya default.
supportState

Jika true, server otorisasi akan menyertakan parameter status dari permintaan otorisasi ke responsnya. Klien dapat menggunakan parameter status untuk meningkatkan keamanan protokol.
tokenBodyParameters

Parameter tambahan yang diperlukan oleh titik akhir token server otorisasi ini diwakili sebagai array objek JSON dengan properti string nama dan nilai, yaitu {"name" : "name value", "value": "a value"}.
tokenEndpoint

Titik akhir token OAuth. Berisi URI absolut ke entitas yang dirujuk.
useInApiDocumentation

Jika true, server otorisasi akan digunakan dalam dokumentasi API di portal pengembang. False secara default jika tidak ada nilai yang disediakan.
useInTestConsole

Jika true, server otorisasi dapat digunakan di konsol pengujian portal pengembang. True secara default jika tidak ada nilai yang disediakan.

Properti yang Diwariskan

id

ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.
name

Nama CATATAN sumber daya: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.
type

Jenis sumber daya. Misalnya CATATAN "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts": Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

Detail Properti

authorizationEndpoint

Titik akhir otorisasi OAuth. Lihat http://tools.ietf.org/html/rfc6749#section-3.2.

authorizationEndpoint?: string

Nilai Properti

string

authorizationMethods

Kata kerja HTTP didukung oleh titik akhir otorisasi. GET harus selalu ada. POST bersifat opsional.

authorizationMethods?: AuthorizationMethod[]

Nilai Properti

AuthorizationMethod[]

bearerTokenSendingMethods

Menentukan mekanisme di mana token akses diteruskan ke API.

bearerTokenSendingMethods?: string[]

Nilai Properti

string[]

clientAuthenticationMethod

Metode autentikasi yang didukung oleh titik akhir token server otorisasi ini. Nilai yang mungkin adalah Dasar dan/atau Isi. Ketika Isi ditentukan, kredensial klien dan parameter lain diteruskan dalam isi permintaan dalam format application/x-www-form-urlencoded.

clientAuthenticationMethod?: string[]

Nilai Properti

string[]

clientId

Id klien atau aplikasi yang terdaftar di server otorisasi ini.

clientId?: string

Nilai Properti

string

clientRegistrationEndpoint

Referensi opsional ke halaman tempat pendaftaran klien atau aplikasi untuk server otorisasi ini dilakukan. Berisi URL absolut ke entitas yang dirujuk.

clientRegistrationEndpoint?: string

Nilai Properti

string

clientSecret

Rahasia klien atau aplikasi yang terdaftar di server otorisasi ini. Properti ini tidak akan diisi pada operasi 'GET'! Gunakan permintaan POST '/listSecrets' untuk mendapatkan nilainya.

clientSecret?: string

Nilai Properti

string

defaultScope

Cakupan token akses yang akan diminta secara default. Dapat ditimpa di tingkat API. Harus disediakan dalam bentuk string yang berisi nilai yang dibatasi spasi.

defaultScope?: string

Nilai Properti

string

description

Deskripsi server otorisasi. Dapat berisi tag pemformatan HTML.

description?: string

Nilai Properti

string

displayName

Nama server otorisasi yang mudah digunakan.

displayName?: string

Nilai Properti

string

grantTypes

Bentuk pemberian otorisasi, yang digunakan klien untuk meminta token akses.

grantTypes?: string[]

Nilai Properti

string[]

resourceOwnerPassword

Dapat ditentukan secara opsional ketika jenis pemberian kata sandi pemilik sumber daya didukung oleh server otorisasi ini. Kata sandi pemilik sumber daya default.

resourceOwnerPassword?: string

Nilai Properti

string

resourceOwnerUsername

Dapat ditentukan secara opsional ketika jenis pemberian kata sandi pemilik sumber daya didukung oleh server otorisasi ini. Nama pengguna pemilik sumber daya default.

resourceOwnerUsername?: string

Nilai Properti

string

supportState

Jika true, server otorisasi akan menyertakan parameter status dari permintaan otorisasi ke responsnya. Klien dapat menggunakan parameter status untuk meningkatkan keamanan protokol.

supportState?: boolean

Nilai Properti

boolean

tokenBodyParameters

Parameter tambahan yang diperlukan oleh titik akhir token server otorisasi ini diwakili sebagai array objek JSON dengan properti string nama dan nilai, yaitu {"name" : "name value", "value": "a value"}.

tokenBodyParameters?: TokenBodyParameterContract[]

Nilai Properti

TokenBodyParameterContract[]

tokenEndpoint

Titik akhir token OAuth. Berisi URI absolut ke entitas yang dirujuk.

tokenEndpoint?: string

Nilai Properti

string

useInApiDocumentation

Jika true, server otorisasi akan digunakan dalam dokumentasi API di portal pengembang. False secara default jika tidak ada nilai yang disediakan.

useInApiDocumentation?: boolean

Nilai Properti

boolean

useInTestConsole

Jika true, server otorisasi dapat digunakan di konsol pengujian portal pengembang. True secara default jika tidak ada nilai yang disediakan.

useInTestConsole?: boolean

Nilai Properti

boolean

Detail Properti yang Diwariskan

id

ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

id?: string

Nilai Properti

string

Diwarisi dari ProxyResource.id

name

Nama CATATAN sumber daya: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

name?: string

Nilai Properti

string

Diwarisi dari ProxyResource.name

type

Jenis sumber daya. Misalnya CATATAN "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts": Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

type?: string

Nilai Properti

string

Diwarisi dariProxyResource.type