AuthorizationServerUpdateContract interface

Paquet:

@azure/arm-apimanagement

Paramètres du serveur d’autorisation OAuth externe.

Extends

ProxyResource

Propriétés

authorizationEndpoint	Point de terminaison d'autorisation OAuth. Consultez http://tools.ietf.org/html/rfc6749#section-3.2.
authorizationMethods	Verbes HTTP pris en charge par le point de terminaison d’autorisation. GET doit toujours être présent. POST est facultatif.
bearerTokenSendingMethods	Spécifie le mécanisme par lequel le jeton d'accès est transmis à l'API.
clientAuthenticationMethod	Méthode d'authentification prise en charge par le point de terminaison de jeton de ce serveur d'autorisation. Les valeurs possibles sont Basic et/ou Body. Lorsque Body est spécifié, les informations d’identification du client et d’autres paramètres sont passées dans le corps de la demande au format application/x-www-form-urlencoded.
clientId	Id de client ou d'application inscrit auprès du serveur d'autorisation.
clientRegistrationEndpoint	Référence facultative à une page où l'inscription du client ou de l'application pour ce serveur d'autorisation est effectuée. Contient l'URL absolue de l'entité référencée.
clientSecret	Clé secrète de client ou d'application inscrite auprès du serveur d'autorisation. Cette propriété ne sera pas remplie sur les opérations « GET » ! Utilisez la requête POST « /listSecrets » pour obtenir la valeur.
defaultScope	Étendue de jeton d'accès à demander par défaut. Peut être remplacée au niveau de l'API. Doit être fournie sous la forme d'une chaîne contenant des valeurs délimitées par des espaces.
description	Description du serveur d'autorisation. Peut contenir des balises au format HTML.
displayName	Nom du serveur d’autorisation convivial.
grantTypes	Forme d’octroi d’autorisation, que le client utilise pour demander le jeton d’accès.
resourceOwnerPassword	Peut être spécifiée lorsque le type d'octroi de mot de passe de propriétaire de ressource est pris en charge par ce serveur d'autorisation. Mot de passe du propriétaire de ressource par défaut.
resourceOwnerUsername	Peut être spécifiée lorsque le type d'octroi de mot de passe de propriétaire de ressource est pris en charge par ce serveur d'autorisation. Nom d'utilisateur du propriétaire de ressource par défaut.
supportState	Si la valeur est true, le serveur d’autorisation inclut le paramètre d’état de la demande d’autorisation à sa réponse. Le client peut utiliser le paramètre d'état pour augmenter la sécurité du protocole.
tokenBodyParameters	Paramètres supplémentaires requis par le point de terminaison de jeton de ce serveur d’autorisation représenté sous la forme d’un tableau d’objets JSON avec des propriétés de nom et de chaîne de valeur, c’est-à-dire {"name » : « name value », « value"}.
tokenEndpoint	Point de terminaison du jeton OAuth. Contient l'URI absolu de l'entité référencée.
useInApiDocumentation	Si la valeur est true, le serveur d’autorisation est utilisé dans la documentation de l’API dans le portail des développeurs. False par défaut si aucune valeur n’est fournie.
useInTestConsole	Si la valeur est true, le serveur d’autorisation peut être utilisé dans la console de test du portail des développeurs. True par défaut si aucune valeur n’est fournie.

Propriétés héritées

id	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.
name	Nom de la ressource REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.
type	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts » REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

Détails de la propriété

authorizationEndpoint

Point de terminaison d'autorisation OAuth. Consultez http://tools.ietf.org/html/rfc6749#section-3.2.

authorizationEndpoint?: string

Valeur de propriété

string

authorizationMethods

Verbes HTTP pris en charge par le point de terminaison d’autorisation. GET doit toujours être présent. POST est facultatif.

authorizationMethods?: AuthorizationMethod[]

Valeur de propriété

AuthorizationMethod[]

bearerTokenSendingMethods

Spécifie le mécanisme par lequel le jeton d'accès est transmis à l'API.

bearerTokenSendingMethods?: string[]

Valeur de propriété

string[]

clientAuthenticationMethod

Méthode d'authentification prise en charge par le point de terminaison de jeton de ce serveur d'autorisation. Les valeurs possibles sont Basic et/ou Body. Lorsque Body est spécifié, les informations d’identification du client et d’autres paramètres sont passées dans le corps de la demande au format application/x-www-form-urlencoded.

clientAuthenticationMethod?: string[]

Valeur de propriété

string[]

clientId

Id de client ou d'application inscrit auprès du serveur d'autorisation.

clientId?: string

Valeur de propriété

string

clientRegistrationEndpoint

Référence facultative à une page où l'inscription du client ou de l'application pour ce serveur d'autorisation est effectuée. Contient l'URL absolue de l'entité référencée.

clientRegistrationEndpoint?: string

Valeur de propriété

string

clientSecret

Clé secrète de client ou d'application inscrite auprès du serveur d'autorisation. Cette propriété ne sera pas remplie sur les opérations « GET » ! Utilisez la requête POST « /listSecrets » pour obtenir la valeur.

clientSecret?: string

Valeur de propriété

string

defaultScope

Étendue de jeton d'accès à demander par défaut. Peut être remplacée au niveau de l'API. Doit être fournie sous la forme d'une chaîne contenant des valeurs délimitées par des espaces.

defaultScope?: string

Valeur de propriété

string

description

Description du serveur d'autorisation. Peut contenir des balises au format HTML.

description?: string

Valeur de propriété

string

displayName

Nom du serveur d’autorisation convivial.

displayName?: string

Valeur de propriété

string

grantTypes

Forme d’octroi d’autorisation, que le client utilise pour demander le jeton d’accès.

grantTypes?: string[]

Valeur de propriété

string[]

resourceOwnerPassword

Peut être spécifiée lorsque le type d'octroi de mot de passe de propriétaire de ressource est pris en charge par ce serveur d'autorisation. Mot de passe du propriétaire de ressource par défaut.

resourceOwnerPassword?: string

Valeur de propriété

string

resourceOwnerUsername

Peut être spécifiée lorsque le type d'octroi de mot de passe de propriétaire de ressource est pris en charge par ce serveur d'autorisation. Nom d'utilisateur du propriétaire de ressource par défaut.

resourceOwnerUsername?: string

Valeur de propriété

string

supportState

Si la valeur est true, le serveur d’autorisation inclut le paramètre d’état de la demande d’autorisation à sa réponse. Le client peut utiliser le paramètre d'état pour augmenter la sécurité du protocole.

supportState?: boolean

Valeur de propriété

boolean

tokenBodyParameters

Paramètres supplémentaires requis par le point de terminaison de jeton de ce serveur d’autorisation représenté sous la forme d’un tableau d’objets JSON avec des propriétés de nom et de chaîne de valeur, c’est-à-dire {"name » : « name value », « value"}.

tokenBodyParameters?: TokenBodyParameterContract[]

Valeur de propriété

TokenBodyParameterContract[]

tokenEndpoint

Point de terminaison du jeton OAuth. Contient l'URI absolu de l'entité référencée.

tokenEndpoint?: string

Valeur de propriété

string

useInApiDocumentation

Si la valeur est true, le serveur d’autorisation est utilisé dans la documentation de l’API dans le portail des développeurs. False par défaut si aucune valeur n’est fournie.

useInApiDocumentation?: boolean

Valeur de propriété

boolean

useInTestConsole

Si la valeur est true, le serveur d’autorisation peut être utilisé dans la console de test du portail des développeurs. True par défaut si aucune valeur n’est fournie.

useInTestConsole?: boolean

Valeur de propriété

boolean

Détails de la propriété héritée

id

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

id?: string

Valeur de propriété

string

Hérité deProxyResource.id

name

Nom de la ressource REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

name?: string

Valeur de propriété

string

Hérité deProxyResource.name

type

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts » REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

type?: string

Valeur de propriété

string

Hérité deProxyResource.type