UpdateGatewayAuth - - Centre de documentation Alibaba Cloud

Met à jour l'authentification de la passerelle.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

mse:UpdateGatewayAuth

update

*Gateway

acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Name	string	Non	Le nom de l'authentification.	test
Type	string	Non	Le type d'authentification. Valeurs valides :	ExternalAuthZ
Issuer	string	Non	Utilisé lorsque le type d'authentification est JWT ou OIDC :	test
Jwks	string	Non	La clé publique JWT. Le format JSON est pris en charge.	{"keys":[{"e":"AQAB","kid":"DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ","kty":"RSA","n":"xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ"}]}
TokenPosition	string	Non	Le type de jeton JWT. Valeurs valides :	HEADER
TokenName	string	Non	L'emplacement où le jeton JWT est stocké.	Authorization
TokenNamePrefix	string	Non	Le préfixe du jeton JWT.	Bearer
TokenPass	boolean	Non	Indique si le jeton doit être transmis.	true
Status	boolean	Non	L'état d'activation. Valeurs valides :	true
Id	integer	Non	L'identifiant de la règle d'authentification.	719
RedirectUrl	string	Non	L'URL de redirection après une autorisation réussie. Ce paramètre est utilisé pour OIDC/IDaaS et doit être cohérent avec l'URL de redirection configurée dans OIDC/IDaaS.	https://test-.com/oauth2/callback
ClientId	string	Non	L'identifiant de l'application enregistrée auprès du service. Ce paramètre est utilisé pour OIDC/IDaaS.	app_mnvxaavggw7hcdcnr6usi6***
ClientSecret	string	Non	Le secret de l'application enregistré auprès du service d'authentification OIDC.	CS6EYfx3k9yTRR9EtQ2MXWP97P6UAUwFg4teoWJ19Z****
CookieDomain	string	Non	Le nom de domaine du cookie. Une fois l'authentification réussie, le cookie est envoyé au nom de domaine spécifié pour maintenir l'état de connexion.	test.com
ScopesList	array	Non	Les étendues d'autorisation OIDC. Ce paramètre est utilisé pour OIDC.
	string	Non	Les étendues d'autorisation OIDC. Ce paramètre est utilisé pour OIDC.	openid
LoginUrl	string	Non	L'URL de la page de connexion de l'utilisateur de l'instance IDaaS. Ce paramètre est utilisé pour IDaaS.	https://daxxxxcn.aliyunidaas.com/
Sub	string	Non	Utilisé lorsque le type d'authentification est JWT. Le champ sub (subject) dans les revendications JWT, qui spécifie le principal. Assurez-vous que la valeur du champ sub dans la charge utile JWT est cohérente avec la valeur configurée ici. Si ce paramètre n'est pas défini ou est vide, la valeur par défaut est celle du paramètre Issuer.	example-app
ExternalAuthZJSON	object	Non	Les informations d'authentification personnalisée.
ServiceId	integer	Non	L'identifiant du service d'authentification.	37396
PrefixPath	string	Non	Le chemin de l'API d'authentification fournie par le service d'authentification. Le chemin de l'API doit utiliser une correspondance de préfixe.	/auth
TokenKey	string	Non	L'en-tête dans lequel se trouve le jeton dans le message de requête. Les valeurs courantes incluent Authorization et Cookie.	Authorization
AllowRequestHeaders	array	Non	Les noms d'en-têtes de requête autorisés.
	string	Non	Les noms d'en-têtes de requête autorisés.	x-req
AllowUpstreamHeaders	array	Non	Les noms d'en-têtes de réponse autorisés.
	string	Non	Les noms d'en-têtes de réponse autorisés.	x-resp
Timeout	integer	Non	Le délai d'expiration du service d'authentification. Unité : secondes.	10
IsRestrict	boolean	Non	Le mode d'authentification personnalisée. Valeurs valides :	true
WithRequestBody	boolean	Non	Indique si l'envoi du corps de la requête est autorisé.	true
BodyMaxBytes	integer	Non	Le nombre maximal d'octets pour le corps.	4000000
WithRematchRoute	boolean	Non	Indique si les routes doivent être réévaluées une fois l'authentification terminée.	true
GatewayUniqueId	string	Non	L'identifiant unique de la passerelle.	gw-9cdcf8e4f58144059e73ff4c5ef9****
IsWhite	boolean	Non	Le mode liste noire/liste blanche d'autorisation. Valeurs valides :	true
AuthResourceMode	integer	Non	Le mode de ressource d'autorisation. Valeurs valides :	1
AuthResourceConfig	string	Non	La configuration YAML pour le mode complexe.	''
AuthResourceList	array<object>	Non	La liste des règles d'autorisation pour l'authentification. Plusieurs conditions de règle ont une relation OU. Plusieurs éléments de correspondance au sein d'une condition de règle ont une relation ET.
	array<object>	Non	La liste des règles d'autorisation pour l'authentification. Plusieurs conditions de règle ont une relation OU. Plusieurs éléments de correspondance au sein d'une condition de règle ont une relation ET.
Id	integer	Non	L'identifiant de l'enregistrement de ressource.	1
DomainId	integer	Non	L'identifiant du nom de domaine dans la règle.	1765
Path	string	Non	Le chemin de correspondance de la règle.	/test
MatchType	string	Non	Le type de correspondance pour le chemin de requête. Valeurs valides :	EQUAL
IgnoreCase	boolean	Non	Indique si la sensibilité à la casse est activée pour le chemin. Ce paramètre est utilisé lors de la création d'une authentification personnalisée. Les autres types d'authentification activent la sensibilité à la casse par défaut. Valeurs valides :
AuthResourceHeaderList	array<object>	Non	Les en-têtes de requête de la règle. Actuellement utilisé uniquement pour l'authentification personnalisée.
	object	Non	Les en-têtes de requête de la règle. Actuellement utilisé uniquement pour l'authentification personnalisée.
HeaderKey	string	Non	Le nom de l'en-tête de requête.	x-req
HeaderMethod	string	Non	La condition de correspondance. Valeurs valides :	EQUAL
HeaderValue	string	Non	La valeur de l'en-tête de requête.	123
DeleteResourceIdList	array	Non	La liste des identifiants d'enregistrements de ressource à supprimer.
	integer	Non	L'identifiant de l'enregistrement de ressource à supprimer.	2
AcceptLanguage	string	Non	La langue de la réponse. Valeurs valides : zh (par défaut) : chinois. en : anglais.	zh

Éléments de réponse

Élément	Type	Description	Exemple
	object	Schéma de la réponse.
RequestId	string	L'identifiant de la requête.	316F5F64-F73D-42DC-8632-01E308B6****
HttpStatusCode	integer	Le code d'état HTTP.	200
Message	string	Le message retourné.	OK
Code	integer	Le code de réponse. La valeur est synchronisée avec le paramètre success.	200
Success	boolean	Indique si la requête a réussi. Valeurs valides :	true
Data	integer	L'identifiant de la règle d'authentification.	719

Exemples

JSON format

{
  "RequestId": "316F5F64-F73D-42DC-8632-01E308B6****",
  "HttpStatusCode": 200,
  "Message": "OK",
  "Code": 200,
  "Success": true,
  "Data": 719
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.