CreateOIDCProvider - - Centre de documentation Alibaba Cloud

Crée un fournisseur d'identité OpenID Connect (OIDC) pour configurer une relation de confiance entre Alibaba Cloud et un IdP externe. Cette rubrique fournit un exemple de création d'un IdP nommé TestOIDCProvider pour configurer une relation de confiance entre l'IdP externe Okta et Alibaba Cloud.

Description de l'opération

Prérequis

Avant d'appeler cette opération, assurez-vous d'avoir obtenu les informations telles que l'URL de l'émetteur, les empreintes des certificats d'autorité de certification (CA) HTTPS et les identifiants client auprès d'un IdP externe, tel que Google Workspace ou Okta.

Limites

Vous pouvez créer un maximum de 100 IdP OIDC dans un compte Alibaba Cloud.
Vous pouvez ajouter un maximum de 50 identifiants client à un IdP OIDC.
Vous pouvez ajouter un maximum de cinq empreintes à un IdP OIDC.

Description de l'opération

Cette rubrique fournit un exemple de création d'un IdP nommé TestOIDCProvider pour configurer une relation de confiance entre l'IdP externe et Alibaba Cloud.

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.

ram:CreateOIDCProvider

create

*All Resource

*

ram:OidcIssuerUrl

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
OIDCProviderName	string	Non	Le nom de l'IdP OIDC. Le nom peut contenir des lettres, des chiffres et des caractères spéciaux, et ne peut pas commencer ou se terminer par ces caractères spéciaux. Les caractères spéciaux sont les `points (.), les tirets (-) et les traits de soulignement (_)`.`` Le nom peut comporter jusqu'à 128 caractères.	TestOIDCProvider
IssuerUrl	string	Non	L'URL de l'émetteur, qui est fournie par l'IdP externe. L'URL de l'émetteur doit être unique au sein d'un compte Alibaba Cloud. L'URL de l'émetteur doit commencer par `https` et être au format URL valide. L'URL ne peut pas contenir de paramètres de requête suivant un point d'interrogation (`?`) ni d'informations de connexion identifiées par des arobases (`@`). L'URL ne peut pas être une URL de fragment contenant des dièses (`#`). L'URL peut comporter jusqu'à 255 caractères.	https://xxxxxx.example.com
Description	string	Non	La description de l'IdP OIDC. La description peut comporter jusqu'à 256 caractères.	Il s'agit d'un fournisseur d'identité OIDC
ClientIds	string	Non	L'identifiant du client, qui est fourni par l'IdP externe. Si vous souhaitez spécifier plusieurs identifiants client, séparez-les par des virgules (,). L'identifiant client peut contenir des lettres, des chiffres et des caractères spéciaux, et ne peut pas commencer par ces caractères spéciaux. Les caractères spéciaux sont les `points (.), les tirets (-), les traits de soulignement (_), les deux-points (:) et les barres obliques (/)`.`` L'identifiant client peut comporter jusqu'à 128 caractères.	498469743454717****
Fingerprints	string	Non	L'empreinte du certificat CA HTTPS, qui est fournie par l'IdP externe. Si vous souhaitez spécifier plusieurs empreintes, séparez-les par des virgules (,). L'empreinte peut contenir des lettres et des chiffres. L'empreinte peut comporter jusqu'à 128 caractères.	902ef2deeb3c5b13ea4c3d5193629309e231****
IssuanceLimitTime	integer	Non	L'heure la plus précoce à laquelle un IdP externe peut émettre un jeton d'ID. Si la valeur du champ iat dans le jeton d'ID est postérieure à l'heure actuelle, la requête est rejetée. Unité : heures. Valeurs valides : 1 à 168.	6

Pour plus d'informations sur les paramètres de requête courants, consultez Référence de l'API.

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de réponse.
RequestId	string	L'identifiant de la requête.	64B11B41-636D-51E3-A39B-C8703CD2218C
OIDCProvider	object	Les informations sur l'IdP OIDC.
UpdateDate	string	L'heure à laquelle l'IdP OIDC a été modifié. L'heure est affichée en UTC.	2021-11-11T06:56:03Z
Description	string	La description de l'IdP OIDC.	Il s'agit d'un fournisseur d'identité OIDC
OIDCProviderName	string	Le nom de l'IdP OIDC.	TestOIDCProvider
CreateDate	string	L'heure à laquelle l'IdP OIDC a été créé. L'heure est affichée en UTC.	2021-11-11T06:56:03Z
Arn	string	L'Alibaba Cloud Resource Name (ARN) de l'IdP OIDC.	acs:ram::177242285274****:oidc-provider/TestOIDCProvider
IssuerUrl	string	L'URL de l'émetteur.	https://xxxxxx.example.com
Fingerprints	string	Les empreintes des certificats HTTPS.	902ef2deeb3c5b13ea4c3d5193629309e231****
ClientIds	string	Les identifiants client.	498469743454717****
GmtCreate	string	L'horodatage de la création de l'IdP OIDC.	1636613763000
GmtModified	string	L'horodatage de la modification de l'IdP OIDC.	1636613763000
IssuanceLimitTime	integer	L'heure la plus précoce à laquelle un IdP externe peut émettre un jeton d'ID. Si la valeur du champ iat dans le jeton d'ID est postérieure à l'heure actuelle, la requête est rejetée. Unité : heures. Valeurs valides : 1 à 168.	6

Exemples

JSON format

{
  "RequestId": "64B11B41-636D-51E3-A39B-C8703CD2218C",
  "OIDCProvider": {
    "UpdateDate": "2021-11-11T06:56:03Z",
    "Description": "This is an OIDC Provider.",
    "OIDCProviderName": "TestOIDCProvider",
    "CreateDate": "2021-11-11T06:56:03Z",
    "Arn": "acs:ram::177242285274****:oidc-provider/TestOIDCProvider",
    "IssuerUrl": "https://xxxxxx.example.com",
    "Fingerprints": "902ef2deeb3c5b13ea4c3d5193629309e231****",
    "ClientIds": "498469743454717****",
    "GmtCreate": "1636613763000",
    "GmtModified": "1636613763000",
    "IssuanceLimitTime": 6
  }
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.