Partager via


AuthorizationServerContractBaseProperties interface

Contrat de paramètres de mise à jour du serveur d’autorisation OAuth externe.

Propriétés

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 passé à 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 De base et/ou Corps. Lorsque le corps est spécifié, les informations d’identification du client et d’autres paramètres sont transmis dans le corps de la requête dans le format application/x-www-form-urlencoded.

defaultScope

Étendue du jeton d’accès qui sera demandée par défaut. Peut être substitué au niveau de l’API. Doit être fourni sous la forme d’une chaîne contenant des valeurs délimitées par un espace.

description

Description du serveur d’autorisation. Peut contenir des balises de mise en forme HTML.

resourceOwnerPassword

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

resourceOwnerUsername

Peut être spécifié éventuellement lorsque le type d’octroi de mot de passe du propriétaire de la ressource est pris en charge par ce serveur d’autorisation. Nom d’utilisateur du propriétaire de la 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 déclencher 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 chaîne de nom et de valeur, par exemple {"name » : « name value », « value » : « a value"}.

tokenEndpoint

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

Détails de la propriété

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é

bearerTokenSendingMethods

Spécifie le mécanisme par lequel le jeton d’accès est passé à 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 De base et/ou Corps. Lorsque le corps est spécifié, les informations d’identification du client et d’autres paramètres sont transmis dans le corps de la requête dans le format application/x-www-form-urlencoded.

clientAuthenticationMethod?: string[]

Valeur de propriété

string[]

defaultScope

Étendue du jeton d’accès qui sera demandée par défaut. Peut être substitué au niveau de l’API. Doit être fourni sous la forme d’une chaîne contenant des valeurs délimitées par un espace.

defaultScope?: string

Valeur de propriété

string

description

Description du serveur d’autorisation. Peut contenir des balises de mise en forme HTML.

description?: string

Valeur de propriété

string

resourceOwnerPassword

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

resourceOwnerPassword?: string

Valeur de propriété

string

resourceOwnerUsername

Peut être spécifié éventuellement lorsque le type d’octroi de mot de passe du propriétaire de la ressource est pris en charge par ce serveur d’autorisation. Nom d’utilisateur du propriétaire de la 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 déclencher 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 chaîne de nom et de valeur, par exemple {"name » : « name value », « value » : « a value"}.

tokenBodyParameters?: TokenBodyParameterContract[]

Valeur de propriété

tokenEndpoint

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

tokenEndpoint?: string

Valeur de propriété

string