Compartir a través de

AuthorizationServerContract interface

  • Referencia
Paquete:
@azure/arm-apimanagement

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

Extends
ProxyResource

Propiedades

authorizationEndpoint

Extremo de autorización OAuth. Vea 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 el token de acceso pasa a la API.
clientAuthenticationMethod

Método de autenticación admitido por el extremo 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 del cliente o la aplicación para este servidor de autorización. Contiene la dirección URL absoluta de 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

Ámbito de token de acceso que se va a solicitar de manera predeterminada. Se puede reemplazar en el nivel de API. Debe proporcionarse en forma de cadena que contiene los valores delimitados por espacios.
description

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

Nombre del servidor de autorización descriptivo.
grantTypes

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

Se puede especificar también cuando este servidor de autorización admite el tipo de concesión de contraseña de propietario de recursos. Contraseña de usuario de propietario de recursos predeterminada.
resourceOwnerUsername

Se puede especificar también cuando este servidor de autorización admite el tipo de concesión de contraseña de propietario de recursos. Nombre de usuario de propietario de recursos predeterminado.
supportState

Si es true, el servidor de autorización incluirá el parámetro state de la solicitud de autorización a su respuesta. El cliente puede utilizar el parámetro de estado para incrementar la seguridad de 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

Extremo de token OAuth. Contiene el URI absoluto de 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 del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
name

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

Tipo de 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

Extremo de autorización OAuth. Vea 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 el token de acceso pasa a la API.

bearerTokenSendingMethods?: string[]

Valor de propiedad

string[]

clientAuthenticationMethod

Método de autenticación admitido por el extremo 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 del cliente o la aplicación para este servidor de autorización. Contiene la dirección URL absoluta de 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

Ámbito de token de acceso que se va a solicitar de manera predeterminada. Se puede reemplazar en el nivel de API. Debe proporcionarse en forma de cadena que contiene los valores delimitados por espacios.

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

displayName?: string

Valor de propiedad

string

grantTypes

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

grantTypes?: string[]

Valor de propiedad

string[]

resourceOwnerPassword

Se puede especificar también cuando este servidor de autorización admite el tipo de concesión de contraseña de propietario de recursos. Contraseña de usuario de propietario de recursos predeterminada.

resourceOwnerPassword?: string

Valor de propiedad

string

resourceOwnerUsername

Se puede especificar también cuando este servidor de autorización admite el tipo de concesión de contraseña de propietario de recursos. Nombre de usuario de propietario de recursos predeterminado.

resourceOwnerUsername?: string

Valor de propiedad

string

supportState

Si es true, el servidor de autorización incluirá el parámetro state de la solicitud de autorización a su respuesta. El cliente puede utilizar el parámetro de estado para incrementar la seguridad de 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

Extremo de token OAuth. Contiene el URI absoluto de 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 del 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

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 de 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