AuthorizationServerContract interface

الحزمة:

@azure/arm-apimanagement

إعدادات خادم تخويل OAuth الخارجي.

يمتد

ProxyResource

الخصائص

authorizationEndpoint	نقطة نهاية تخويل OAuth. راجع http://tools.ietf.org/html/rfc6749#section-3.2.
authorizationMethods	أفعال HTTP المدعومة بنقطة نهاية التخويل. يجب أن يكون GET موجودا دائما. POST اختياري.
bearerTokenSendingMethods	تحديد الآلية التي يتم من خلالها تمرير الرمز المميز للوصول إلى واجهة برمجة التطبيقات.
clientAuthenticationMethod	طريقة المصادقة المدعومة من قبل نقطة نهاية الرمز المميز لخادم التخويل هذا. القيم المحتملة هي Basic و/أو Body. عند تحديد النص الأساسي، يتم تمرير بيانات اعتماد العميل والمعلمات الأخرى داخل نص الطلب بتنسيق application/x-www-form-urlencoded.
clientId	معرف العميل أو التطبيق المسجل مع خادم التخويل هذا.
clientRegistrationEndpoint	مرجع اختياري إلى صفحة يتم فيها إجراء تسجيل العميل أو التطبيق لخادم التخويل هذا. يحتوي على URL مطلق للكيان الذي تتم الإشارة إليه.
clientSecret	سر العميل أو التطبيق المسجل مع خادم التخويل هذا. لن يتم ملء هذه الخاصية في عمليات "GET"! استخدم طلب POST '/listSecrets' للحصول على القيمة.
defaultScope	نطاق الرمز المميز للوصول الذي سيتم طلبه بشكل افتراضي. يمكن تجاوزه على مستوى واجهة برمجة التطبيقات. يجب توفيرها في شكل سلسلة تحتوي على قيم محددة بالمساحة.
description	وصف خادم التخويل. يمكن أن يحتوي على علامات تنسيق HTML.
displayName	اسم خادم التخويل سهل الاستخدام.
grantTypes	شكل منحة تخويل، يستخدمها العميل لطلب رمز الوصول المميز.
resourceOwnerPassword	يمكن تحديد اختياريا عند دعم نوع منح كلمة مرور مالك المورد بواسطة خادم التخويل هذا. كلمة مرور مالك المورد الافتراضية.
resourceOwnerUsername	يمكن تحديد اختياريا عند دعم نوع منح كلمة مرور مالك المورد بواسطة خادم التخويل هذا. اسم المستخدم الافتراضي لمالك المورد.
supportState	إذا كان صحيحا، فسيتضمن خادم التخويل معلمة الحالة من طلب التخويل إلى استجابته. قد يستخدم العميل معلمة الحالة لرفع أمان البروتوكول.
tokenBodyParameters	معلمات إضافية مطلوبة بواسطة نقطة نهاية الرمز المميز لخادم التخويل هذا ممثلة كصفيف من كائنات JSON ذات خصائص سلسلة الاسم والقيمة، أي {"name": "name value", "value": "a value"}.
tokenEndpoint	نقطة نهاية الرمز المميز OAuth. يحتوي على URI مطلق للكيان الذي تتم الإشارة إليه.
useInApiDocumentation	إذا كان صحيحا، استخدام خادم التخويل في وثائق واجهة برمجة التطبيقات في مدخل المطور. خطأ بشكل افتراضي إذا لم يتم توفير قيمة.
useInTestConsole	إذا كان صحيحا، يمكن استخدام خادم التخويل في وحدة تحكم اختبار مدخل المطور. صواب بشكل افتراضي إذا لم يتم توفير أي قيمة.

الخصائص الموروثة

id	معرف المورد المؤهل بالكامل للمورد. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.
name	اسم المورد NOTE: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.
type	نوع المورد. على سبيل المثال، ملاحظة "Microsoft.Compute/virtualMachines" أو "Microsoft.Storage/storageAccounts": لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.

تفاصيل الخاصية

authorizationEndpoint

نقطة نهاية تخويل OAuth. راجع http://tools.ietf.org/html/rfc6749#section-3.2.

authorizationEndpoint?: string

قيمة الخاصية

string

authorizationMethods

أفعال HTTP المدعومة بنقطة نهاية التخويل. يجب أن يكون GET موجودا دائما. POST اختياري.

authorizationMethods?: AuthorizationMethod[]

قيمة الخاصية

AuthorizationMethod[]

bearerTokenSendingMethods

تحديد الآلية التي يتم من خلالها تمرير الرمز المميز للوصول إلى واجهة برمجة التطبيقات.

bearerTokenSendingMethods?: string[]

قيمة الخاصية

string[]

clientAuthenticationMethod

طريقة المصادقة المدعومة من قبل نقطة نهاية الرمز المميز لخادم التخويل هذا. القيم المحتملة هي Basic و/أو Body. عند تحديد النص الأساسي، يتم تمرير بيانات اعتماد العميل والمعلمات الأخرى داخل نص الطلب بتنسيق application/x-www-form-urlencoded.

clientAuthenticationMethod?: string[]

قيمة الخاصية

string[]

clientId

معرف العميل أو التطبيق المسجل مع خادم التخويل هذا.

clientId?: string

قيمة الخاصية

string

clientRegistrationEndpoint

مرجع اختياري إلى صفحة يتم فيها إجراء تسجيل العميل أو التطبيق لخادم التخويل هذا. يحتوي على URL مطلق للكيان الذي تتم الإشارة إليه.

clientRegistrationEndpoint?: string

قيمة الخاصية

string

clientSecret

سر العميل أو التطبيق المسجل مع خادم التخويل هذا. لن يتم ملء هذه الخاصية في عمليات "GET"! استخدم طلب POST '/listSecrets' للحصول على القيمة.

clientSecret?: string

قيمة الخاصية

string

defaultScope

نطاق الرمز المميز للوصول الذي سيتم طلبه بشكل افتراضي. يمكن تجاوزه على مستوى واجهة برمجة التطبيقات. يجب توفيرها في شكل سلسلة تحتوي على قيم محددة بالمساحة.

defaultScope?: string

قيمة الخاصية

string

description

وصف خادم التخويل. يمكن أن يحتوي على علامات تنسيق HTML.

description?: string

قيمة الخاصية

string

displayName

اسم خادم التخويل سهل الاستخدام.

displayName?: string

قيمة الخاصية

string

grantTypes

شكل منحة تخويل، يستخدمها العميل لطلب رمز الوصول المميز.

grantTypes?: string[]

قيمة الخاصية

string[]

resourceOwnerPassword

يمكن تحديد اختياريا عند دعم نوع منح كلمة مرور مالك المورد بواسطة خادم التخويل هذا. كلمة مرور مالك المورد الافتراضية.

resourceOwnerPassword?: string

قيمة الخاصية

string

resourceOwnerUsername

يمكن تحديد اختياريا عند دعم نوع منح كلمة مرور مالك المورد بواسطة خادم التخويل هذا. اسم المستخدم الافتراضي لمالك المورد.

resourceOwnerUsername?: string

قيمة الخاصية

string

supportState

إذا كان صحيحا، فسيتضمن خادم التخويل معلمة الحالة من طلب التخويل إلى استجابته. قد يستخدم العميل معلمة الحالة لرفع أمان البروتوكول.

supportState?: boolean

قيمة الخاصية

boolean

tokenBodyParameters

معلمات إضافية مطلوبة بواسطة نقطة نهاية الرمز المميز لخادم التخويل هذا ممثلة كصفيف من كائنات JSON ذات خصائص سلسلة الاسم والقيمة، أي {"name": "name value", "value": "a value"}.

tokenBodyParameters?: TokenBodyParameterContract[]

قيمة الخاصية

TokenBodyParameterContract[]

tokenEndpoint

نقطة نهاية الرمز المميز OAuth. يحتوي على URI مطلق للكيان الذي تتم الإشارة إليه.

tokenEndpoint?: string

قيمة الخاصية

string

useInApiDocumentation

إذا كان صحيحا، استخدام خادم التخويل في وثائق واجهة برمجة التطبيقات في مدخل المطور. خطأ بشكل افتراضي إذا لم يتم توفير قيمة.

useInApiDocumentation?: boolean

قيمة الخاصية

boolean

useInTestConsole

إذا كان صحيحا، يمكن استخدام خادم التخويل في وحدة تحكم اختبار مدخل المطور. صواب بشكل افتراضي إذا لم يتم توفير أي قيمة.

useInTestConsole?: boolean

قيمة الخاصية

boolean

تفاصيل الخاصية الموروثة

id

معرف المورد المؤهل بالكامل للمورد. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.

id?: string

قيمة الخاصية

string

موروث منProxyResource.id

name

اسم المورد NOTE: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.

name?: string

قيمة الخاصية

string

موروث منProxyResource.name

type

نوع المورد. على سبيل المثال، ملاحظة "Microsoft.Compute/virtualMachines" أو "Microsoft.Storage/storageAccounts": لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.

type?: string

قيمة الخاصية

string

موروث منProxyResource.type