For AI agents: the complete documentation index is available at https://docs.dataplatform.ovh.net/ja/llms.txt, the full documentation bundle is available at https://docs.dataplatform.ovh.net/ja/llms-full.txt, and this page is available as Markdown at https://docs.dataplatform.ovh.net/ja/legacy/api-reference-iam.md.
  • 🇯🇵 日本語

    • API リファレンス: Identity Access Manager

    Warning

    このページでは、ForePaaS レガシープラットフォームについて説明しています。このプラットフォームは新規登録を受け付けていません。OVHcloud Data Platformをご利用の場合は、最新のIAM APIリファレンスを参照してください。

    このページでは、Identity Access Manager (IAM)のAPIリファレンスを説明しています。IAM APIは常に以下のようになります：

    https://`%dataplant_url%/iam

    ログインエンドポイント

    ログイン/パスワード方法を使用する

    この認証モードでは、ログインとパスワードで接続できます。ログインとパスワードは、Identity Access Managerで定義されています。

    例リクエスト：

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

    例レスポンス：

    {
"uid": "John Doe", // The unique id of the logged-in user
"user": "M. John Doe", // The full name of the logged-in user
"firstname": "John", // The first name of the logged-in user
"lastname": "Doe", // The last name of the logged-in user
"civility": "M. ", // The civility of the logged-in user
"login": "john.doe", // The login of the logged-in user
"password_renew": false, // flag to know if the has to change his password "password_expiration": "2020-02-28T17:17:10.274Z ", // password expiration
date
"token": "f54e34a56b897"
}
    loginString登録メールで受け取ったユーザーのログイン情報。
    passwordString登録メールで受け取ったユーザーのパスワード。
    app_idStringアプリケーション識別子（プロジェクトのIAMにログインする場合は'forepaas'に設定）
    auth_modeString使用する認証モード。値は「forepaas_id_resource_owner」に設定する必要があります。

    APIキー資格情報

    この認証モードでは、APIキーとシークレットキーで接続できます。APIキーとシークレットキーは、Identity Access Managerで定義されています。

    例リクエスト：

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

    例レスポンス：

    {
"uid": "John Doe", // The unique id of the logged-in user
"user": "M. John Doe", // The full name of the logged-in user
"firstname": "John", // The first name of the logged-in user
"lastname": "Doe", // The last name of the logged-in user
"civility": "M. ", // The civility of the logged-in user
"login": "john.doe", // The login of the logged-in user
"password_renew": false, // flag to know if the has to change his password "password_expiration": "2020-02-28T17:17:10.274Z ", // password expiration
date
"token": "f54e34a56b897"
}
    apikeyString [A-Za-z0- 9-]新しいデバイス登録で提供されたAPIキー。
    secretkeyString [A-Za-z0- 9-]新しいデバイス登録で提供されたシークレットキー。
    app_idStringアプリケーション識別子（プロジェクトのIAMにログインする場合は'forepaas'に設定）
    auth_modeString使用する認証モード。値は「apikey」に設定する必要があります。

    ログアウトエンドポイント

    トークンを削除するには、ログアウトエンドポイントを呼び出すことができます。

    例リクエスト：

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

    例レスポンス：

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