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/developers-api-authentication.md.
  • 🇯🇵 日本語
  • Data Platform IAM API に認証する

    このページには、Identity Access Manager (IAM) の API リファレンスが含まれています

    目的

    このページには、Identity Access Manager (IAM) の API リファレンスが含まれています。IAM API は常に次のようになります:

    https://{project_url}/iam

    ログインエンドポイント

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

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

    Info

    以下のコードスニペットのベースURLでは、my-projectプロジェクトのサブドメインに置き換える必要があります。

    例リクエスト:

    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"
    }'

    :::

    例レスポンス:

    {
    "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 user has to change their password
    "password_expiration": "2020-02-28T17:17:10.274Z", // password expiration date
    "token": "f54e34a56b897"
    }
    NameTypeDescription
    loginString登録メールで受け取ったユーザーのログイン情報。
    passwordString登録メールで受け取ったユーザーのパスワード。
    app_idStringアプリケーション識別子(プロジェクトのIAMにログインするには'forepaas'に設定)
    auth_modeString使用する認証モード。値は「forepaas_id_resource_owner」に設定する必要があります

    API キー資格情報

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

    Info

    以下のコードスニペットのベースURLでは、my-projectプロジェクトのサブドメインに置き換える必要があります。

    例リクエスト:

    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"
    }'

    :::

    例レスポンス:

    {
    "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 user has to change their password
    "password_expiration": "2020-02-28T17:17:10.274Z", // password expiration date
    "token": "f54e34a56b897"
    }
    NameTypeDescription
    apikeyString [A-Za-z0- 9-]新しいデバイス登録で提供されたAPIキー。
    secretkeyString [A-Za-z0- 9-]新しいデバイス登録で提供されたシークレットキー。
    app_idStringアプリケーション識別子(プロジェクトのIAMにログインするには'forepaas'に設定)
    auth_modeString使用する認証モード。値は「apikey」に設定する必要があります

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

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

    Info

    以下のコードスニペットのベースURLでは、my-projectプロジェクトのサブドメインに置き換える必要があります。

    例リクエスト:

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

    :::

    例レスポンス:

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

    さらに進む

    当社のソリューションを実装するためのトレーニングや技術サポートが必要な場合は、営業担当者にお問い合わせください、またはこのリンクをクリックして見積もりを依頼し、当社のプロフェッショナルサービスの専門家にプロジェクトのカスタム分析を依頼してください。

    専用のDiscordチャネルでData Platformを構築しているチームと直接質問し、フィードバックを共有し、交流してください。

    OVHcloudサービスについてサポートが必要な場合は、ヘルプセンターでリクエストを作成してください。

    ユーザーコミュニティに参加してください。