Authentification auprès de l'API IAM de la Data Platform

Cette page contient la référence API pour l'Identity Access Manager (IAM)

Objectif

Cette page contient la référence API pour l'Identity Access Manager (IAM). Les API IAM ressembleront toujours à ceci :

https://{project_url}/iam

Endpoint de connexion

Utiliser une méthode login/mot de passe

Ce mode d'authentification vous permet de vous connecter avec un login et un mot de passe défini dans votre Identity Access Manager.

Info

Dans les URL de base des extraits de code ci-dessous, vous devrez remplacer my-project par le sous-domaine de votre projet.

Exemple de requête :

curl -X POST \
  https://my-project.eu.dataplatform.ovh.net/iam/login \
  -H 'Content-Type: application/json' \
  -d '{
	"login":"LOGIN",
	"password":"****",
	"app_id":"APPID",
	"auth_mode":"forepaas_id_resource_owner"
}'

:::

Exemple de réponse :

{
"uid": "John Doe", // L'identifiant unique de l'utilisateur connecté
"user": "M. John Doe", // Le nom complet de l'utilisateur connecté
"firstname": "John", // Le prénom de l'utilisateur connecté
"lastname": "Doe", // Le nom de famille de l'utilisateur connecté
"civility": "M. ", // La civilité de l'utilisateur connecté
"login": "john.doe", // Le login de l'utilisateur connecté
"password_renew": false, // indicateur pour savoir si l'utilisateur doit changer son mot de passe
"password_expiration": "2020-02-28T17:17:10.274Z", // date d'expiration du mot de passe
"token": "f54e34a56b897"
}

Nom	Type	Description
login	String	Le login de l'utilisateur, tel que reçu dans l'e-mail d'inscription.
password	String	Le mot de passe de l'utilisateur, tel que reçu dans l'e-mail d'inscription.
app_id	String	L'identifiant de l'application (défini sur 'forepaas' pour se connecter à l'IAM du projet en général)
auth_mode	String	Le mode d'authentification à utiliser. La valeur doit être définie sur « forepaas_id_resource_owner »

API Key Credentials

Ce mode d'authentification vous permet de vous connecter avec une clé API et une clé secrète définies dans votre Identity Access Manager.

Info

Dans les URL de base des extraits de code ci-dessous, vous devrez remplacer my-project par le sous-domaine de votre projet.

Exemple de requête :

curl -X POST \
  https://my-project.eu.dataplatform.ovh.net/iam/login \
  -H 'Content-Type: application/json' \
  -d '{
	"apikey":"APIKEY",
	"secretkey":"****",
	"app_id":"APPID",
	"auth_mode":"apikey"
}'

:::

Exemple de réponse :

{
"uid": "John Doe", // L'identifiant unique de l'utilisateur connecté
"user": "M. John Doe", // Le nom complet de l'utilisateur connecté
"firstname": "John", // Le prénom de l'utilisateur connecté
"lastname": "Doe", // Le nom de famille de l'utilisateur connecté
"civility": "M. ", // La civilité de l'utilisateur connecté
"login": "john.doe", // Le login de l'utilisateur connecté
"password_renew": false, // indicateur pour savoir si l'utilisateur doit changer son mot de passe
"password_expiration": "2020-02-28T17:17:10.274Z", // date d'expiration du mot de passe
"token": "f54e34a56b897"
}

Nom	Type	Description
apikey	String [A-Za-z0- 9-]	La clé API fournie lors de l'enregistrement du nouvel appareil.
secretkey	String [A-Za-z0- 9-]	La clé secrète fournie lors de l'enregistrement du nouvel appareil.
app_id	String	L'identifiant de l'application (défini sur 'forepaas' pour se connecter à l'IAM du projet en général)
auth_mode	String	Le mode d'authentification à utiliser. La valeur doit être définie sur « apikey »

Endpoint de déconnexion

Afin de supprimer un token, vous pouvez appeler l'endpoint de déconnexion.

Info

Dans les URL de base des extraits de code ci-dessous, vous devrez remplacer my-project par le sous-domaine de votre projet.

Exemple de requête :

curl -X DELETE \
  https://my-project.eu.dataplatform.ovh.net/iam/logout?app_id=*****&token=***** \
  -H 'Content-Type: application/json'

:::

Exemple de réponse :

{
  "success": true,
  "status": 200,
  "duration": 0.02
}

Aller plus loin

Si vous avez besoin d'une formation ou d'une assistance technique pour la mise en oeuvre de nos solutions, contactez votre commercial ou cliquez sur ce lien pour obtenir un devis et demander une analyse personnalisée de votre projet à nos experts de l’équipe Professional Services.

Posez vos questions, faites-nous part de vos commentaires et interagissez directement avec l’équipe qui développe la Data Platform sur le canal Discord dédié.

Si vous avez besoin d'une assistance concernant vos services OVHcloud, créez une demande depuis notre centre d'aide.

Rejoignez notre communauté d'utilisateurs.

Cette page vous a-t-elle aidé ?