Поделиться через

AuthorizationServerContractProperties interface

  • Ссылка
Пакет:
@azure/arm-apimanagement

Внешние параметры сервера авторизации OAuth Свойства.

Extends
AuthorizationServerContractBaseProperties

Свойства

authorizationEndpoint

Конечная точка авторизации по протоколу OAuth. См. раздел http://tools.ietf.org/html/rfc6749#section-3.2.
clientId

Идентификатор клиента или приложения, зарегистрированный для этого сервера авторизации.
clientRegistrationEndpoint

Дополнительная ссылка на страницу, где выполняется регистрация клиента или приложения для этого сервера авторизации. Содержит абсолютный URL-адрес сущности, на которую имеется ссылка.
clientSecret

Секрет клиента или приложения, зарегистрированный для этого сервера авторизации. Это свойство не будет заполнено при операциях GET! Используйте запрос POST /listSecrets, чтобы получить значение.
displayName

Понятное имя сервера авторизации.
grantTypes

Форма предоставления авторизации, которую клиент использует для запроса маркера доступа.
useInApiDocumentation

Если значение равно true, сервер авторизации будет использоваться в документации по API на портале разработчика. Значение false по умолчанию, если значение не указано.
useInTestConsole

Если значение равно true, сервер авторизации можно использовать в тестовой консоли портала разработчика. Значение true по умолчанию, если значение не указано.

Унаследованные свойства

authorizationMethods

HTTP-команды, поддерживаемые на конечной точке авторизации. Get должен присутствовать всегда. POST является необязательным.
bearerTokenSendingMethods

Определяет, с помощью какого механизма токен доступа передается API.
clientAuthenticationMethod

Метод аутентификации, поддерживаемой конечной точкой токена этого сервера авторизации. Возможные значения: Basic и (или) Body. Если указан текст , учетные данные клиента и другие параметры передаются в тексте запроса в формате application/x-www-form-urlencoded.
defaultScope

Область маркера доступа , которая будет запрашиваться по умолчанию. Можно переопределить на уровне API. Необходимо предоставить в форме строки, содержащей разделенные пробелами значения.
description

Описание сервера авторизации. Может содержать теги форматирования HTML.
resourceOwnerPassword

Можно указать при необходимости, если тип предоставления пароля владельца ресурса поддерживается этим сервером авторизации. Пароль владельца ресурса по умолчанию.
resourceOwnerUsername

Можно указать при необходимости, если тип предоставления пароля владельца ресурса поддерживается этим сервером авторизации. Имя пользователя владельца ресурса по умолчанию.
supportState

Если задано значение true, сервер авторизации будет включать параметр состояния из запроса авторизации в его ответ. Клиент может использовать параметр состояния для повышения безопасности протокола.
tokenBodyParameters

Дополнительные параметры, необходимые для конечной точки маркера этого сервера авторизации, представленные в виде массива объектов JSON со свойствами строки name и value, т. е. {"name" : "name value", "value": "a value"}.
tokenEndpoint

Конечная точка токена OAuth. Содержит абсолютный URI сущности, на которую имеется ссылка.

Сведения о свойстве

authorizationEndpoint

Конечная точка авторизации по протоколу OAuth. См. раздел http://tools.ietf.org/html/rfc6749#section-3.2.

authorizationEndpoint: string

Значение свойства

string

clientId

Идентификатор клиента или приложения, зарегистрированный для этого сервера авторизации.

clientId: string

Значение свойства

string

clientRegistrationEndpoint

Дополнительная ссылка на страницу, где выполняется регистрация клиента или приложения для этого сервера авторизации. Содержит абсолютный URL-адрес сущности, на которую имеется ссылка.

clientRegistrationEndpoint: string

Значение свойства

string

clientSecret

Секрет клиента или приложения, зарегистрированный для этого сервера авторизации. Это свойство не будет заполнено при операциях GET! Используйте запрос POST /listSecrets, чтобы получить значение.

clientSecret?: string

Значение свойства

string

displayName

Понятное имя сервера авторизации.

displayName: string

Значение свойства

string

grantTypes

Форма предоставления авторизации, которую клиент использует для запроса маркера доступа.

grantTypes: string[]

Значение свойства

string[]

useInApiDocumentation

Если значение равно true, сервер авторизации будет использоваться в документации по API на портале разработчика. Значение false по умолчанию, если значение не указано.

useInApiDocumentation?: boolean

Значение свойства

boolean

useInTestConsole

Если значение равно true, сервер авторизации можно использовать в тестовой консоли портала разработчика. Значение true по умолчанию, если значение не указано.

useInTestConsole?: boolean

Значение свойства

boolean

Сведения об унаследованном свойстве

authorizationMethods

HTTP-команды, поддерживаемые на конечной точке авторизации. Get должен присутствовать всегда. POST является необязательным.

authorizationMethods?: AuthorizationMethod[]

Значение свойства

AuthorizationMethod[]

Наследуется отAuthorizationServerContractBaseProperties.authorizationMethods

bearerTokenSendingMethods

Определяет, с помощью какого механизма токен доступа передается API.

bearerTokenSendingMethods?: string[]

Значение свойства

string[]

Наследуется отAuthorizationServerContractBaseProperties.bearerTokenSendingMethods

clientAuthenticationMethod

Метод аутентификации, поддерживаемой конечной точкой токена этого сервера авторизации. Возможные значения: Basic и (или) Body. Если указан текст , учетные данные клиента и другие параметры передаются в тексте запроса в формате application/x-www-form-urlencoded.

clientAuthenticationMethod?: string[]

Значение свойства

string[]

Наследуется отAuthorizationServerContractBaseProperties.clientAuthenticationMethod

defaultScope

Область маркера доступа , которая будет запрашиваться по умолчанию. Можно переопределить на уровне API. Необходимо предоставить в форме строки, содержащей разделенные пробелами значения.

defaultScope?: string

Значение свойства

string

Наследуется отAuthorizationServerContractBaseProperties.defaultScope

description

Описание сервера авторизации. Может содержать теги форматирования HTML.

description?: string

Значение свойства

string

Наследуется отAuthorizationServerContractBaseProperties.description

resourceOwnerPassword

Можно указать при необходимости, если тип предоставления пароля владельца ресурса поддерживается этим сервером авторизации. Пароль владельца ресурса по умолчанию.

resourceOwnerPassword?: string

Значение свойства

string

Наследуется отAuthorizationServerContractBaseProperties.resourceOwnerPassword

resourceOwnerUsername

Можно указать при необходимости, если тип предоставления пароля владельца ресурса поддерживается этим сервером авторизации. Имя пользователя владельца ресурса по умолчанию.

resourceOwnerUsername?: string

Значение свойства

string

Наследуется отAuthorizationServerContractBaseProperties.resourceOwnerUsername

supportState

Если задано значение true, сервер авторизации будет включать параметр состояния из запроса авторизации в его ответ. Клиент может использовать параметр состояния для повышения безопасности протокола.

supportState?: boolean

Значение свойства

boolean

Наследуется отAuthorizationServerContractBaseProperties.supportState

tokenBodyParameters

Дополнительные параметры, необходимые для конечной точки маркера этого сервера авторизации, представленные в виде массива объектов JSON со свойствами строки name и value, т. е. {"name" : "name value", "value": "a value"}.

tokenBodyParameters?: TokenBodyParameterContract[]

Значение свойства

TokenBodyParameterContract[]

Наследуется отAuthorizationServerContractBaseProperties.tokenBodyParameters

tokenEndpoint

Конечная точка токена OAuth. Содержит абсолютный URI сущности, на которую имеется ссылка.

tokenEndpoint?: string

Значение свойства

string

Наследуется отAuthorizationServerContractBaseProperties.tokenEndpoint