AuthorizationServerContract interface

Paquete:

@azure/arm-apimanagement

Configuración externa del servidor de autorización de OAuth.

Extends

ProxyResource

Propiedades

authorizationEndpoint	Punto de conexión de autorización de OAuth. Consulte http://tools.ietf.org/html/rfc6749#section-3.2.
authorizationMethods	Verbos HTTP admitidos por el punto de conexión de autorización. GET debe estar siempre presente. POST es opcional.
bearerTokenSendingMethods	Especifica el mecanismo por el que se pasa el token de acceso a la API.
clientAuthenticationMethod	Método de autenticación admitido por el punto de conexión de token de este servidor de autorización. Los valores posibles son Basic o Body. Cuando se especifica Body, las credenciales de cliente y otros parámetros se pasan dentro del cuerpo de la solicitud en el formato application/x-www-form-urlencoded.
clientId	Identificador de cliente o aplicación registrado con este servidor de autorización.
clientRegistrationEndpoint	Referencia opcional a una página donde se realiza el registro de cliente o aplicación para este servidor de autorización. Contiene la dirección URL absoluta a la entidad a la que se hace referencia.
clientSecret	Secreto de cliente o aplicación registrado con este servidor de autorización. ¡Esta propiedad no se rellenará en las operaciones 'GET'! Use la solicitud POST "/listSecrets" para obtener el valor.
defaultScope	El ámbito del token de acceso que se va a solicitar de forma predeterminada. Se puede invalidar en el nivel de API. Debe proporcionarse en forma de una cadena que contenga valores delimitados por espacio.
description	Descripción del servidor de autorización. Puede contener etiquetas de formato HTML.
displayName	Nombre del servidor de autorización fácil de usar.
grantTypes	Formulario de una concesión de autorización, que el cliente usa para solicitar el token de acceso.
resourceOwnerPassword	Opcionalmente, se puede especificar cuando este servidor de autorización admite el tipo de concesión de contraseña del propietario del recurso. Contraseña predeterminada del propietario del recurso.
resourceOwnerUsername	Opcionalmente, se puede especificar cuando este servidor de autorización admite el tipo de concesión de contraseña del propietario del recurso. Nombre de usuario del propietario del recurso predeterminado.
supportState	Si es true, el servidor de autorización incluirá el parámetro de estado de la solicitud de autorización a su respuesta. El cliente puede usar el parámetro de estado para aumentar la seguridad del protocolo.
tokenBodyParameters	Parámetros adicionales requeridos por el punto de conexión de token de este servidor de autorización representado como una matriz de objetos JSON con propiedades de cadena de nombre y valor, es decir, {"name" : "name value", "value": "a value"}.
tokenEndpoint	Punto de conexión del token de OAuth. Contiene un URI absoluto a la entidad a la que se hace referencia.
useInApiDocumentation	Si es true, el servidor de autorización se usará en la documentación de la API del portal para desarrolladores. False de forma predeterminada si no se proporciona ningún valor.
useInTestConsole	Si es true, el servidor de autorización se puede usar en la consola de prueba del portal para desarrolladores. True de forma predeterminada si no se proporciona ningún valor.

Propiedades heredadas

id	Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
name	El nombre del recurso NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
type	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

Detalles de las propiedades

authorizationEndpoint

Punto de conexión de autorización de OAuth. Consulte http://tools.ietf.org/html/rfc6749#section-3.2.

authorizationEndpoint?: string

Valor de propiedad

string

authorizationMethods

Verbos HTTP admitidos por el punto de conexión de autorización. GET debe estar siempre presente. POST es opcional.

authorizationMethods?: AuthorizationMethod[]

Valor de propiedad

AuthorizationMethod[]

bearerTokenSendingMethods

Especifica el mecanismo por el que se pasa el token de acceso a la API.

bearerTokenSendingMethods?: string[]

Valor de propiedad

string[]

clientAuthenticationMethod

Método de autenticación admitido por el punto de conexión de token de este servidor de autorización. Los valores posibles son Basic o Body. Cuando se especifica Body, las credenciales de cliente y otros parámetros se pasan dentro del cuerpo de la solicitud en el formato application/x-www-form-urlencoded.

clientAuthenticationMethod?: string[]

Valor de propiedad

string[]

clientId

Identificador de cliente o aplicación registrado con este servidor de autorización.

clientId?: string

Valor de propiedad

string

clientRegistrationEndpoint

Referencia opcional a una página donde se realiza el registro de cliente o aplicación para este servidor de autorización. Contiene la dirección URL absoluta a la entidad a la que se hace referencia.

clientRegistrationEndpoint?: string

Valor de propiedad

string

clientSecret

Secreto de cliente o aplicación registrado con este servidor de autorización. ¡Esta propiedad no se rellenará en las operaciones 'GET'! Use la solicitud POST "/listSecrets" para obtener el valor.

clientSecret?: string

Valor de propiedad

string

defaultScope

El ámbito del token de acceso que se va a solicitar de forma predeterminada. Se puede invalidar en el nivel de API. Debe proporcionarse en forma de una cadena que contenga valores delimitados por espacio.

defaultScope?: string

Valor de propiedad

string

description

Descripción del servidor de autorización. Puede contener etiquetas de formato HTML.

description?: string

Valor de propiedad

string

displayName

Nombre del servidor de autorización fácil de usar.

displayName?: string

Valor de propiedad

string

grantTypes

Formulario de una concesión de autorización, que el cliente usa para solicitar el token de acceso.

grantTypes?: string[]

Valor de propiedad

string[]

resourceOwnerPassword

Opcionalmente, se puede especificar cuando este servidor de autorización admite el tipo de concesión de contraseña del propietario del recurso. Contraseña predeterminada del propietario del recurso.

resourceOwnerPassword?: string

Valor de propiedad

string

resourceOwnerUsername

Opcionalmente, se puede especificar cuando este servidor de autorización admite el tipo de concesión de contraseña del propietario del recurso. Nombre de usuario del propietario del recurso predeterminado.

resourceOwnerUsername?: string

Valor de propiedad

string

supportState

Si es true, el servidor de autorización incluirá el parámetro de estado de la solicitud de autorización a su respuesta. El cliente puede usar el parámetro de estado para aumentar la seguridad del protocolo.

supportState?: boolean

Valor de propiedad

boolean

tokenBodyParameters

Parámetros adicionales requeridos por el punto de conexión de token de este servidor de autorización representado como una matriz de objetos JSON con propiedades de cadena de nombre y valor, es decir, {"name" : "name value", "value": "a value"}.

tokenBodyParameters?: TokenBodyParameterContract[]

Valor de propiedad

TokenBodyParameterContract[]

tokenEndpoint

Punto de conexión del token de OAuth. Contiene un URI absoluto a la entidad a la que se hace referencia.

tokenEndpoint?: string

Valor de propiedad

string

useInApiDocumentation

Si es true, el servidor de autorización se usará en la documentación de la API del portal para desarrolladores. False de forma predeterminada si no se proporciona ningún valor.

useInApiDocumentation?: boolean

Valor de propiedad

boolean

useInTestConsole

Si es true, el servidor de autorización se puede usar en la consola de prueba del portal para desarrolladores. True de forma predeterminada si no se proporciona ningún valor.

useInTestConsole?: boolean

Valor de propiedad

boolean

Detalles de las propiedades heredadas

id

Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

id?: string

Valor de propiedad

string

heredado deProxyResource.id

name

El nombre del recurso NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

name?: string

Valor de propiedad

string

heredado deProxyResource.name

type

Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

type?: string

Valor de propiedad

string

Heredado deProxyResource.type