ドメイン管理APIの認証方法

本ページには未リリースの機能に関する情報が含まれています。

CloudGearのドメイン管理APIをWebアプリケーション以外のクライアントで使用する場合、事前にクライアントの登録(クライアントIDおよびシークレットの発行)が必要になります。本項ではこの手順について説明します。

認証方法について

ドメイン管理APIでは、ドメイン管理権限をCloudGearの外部のアプリケーションに権限を委譲する形で、アプリケーションがドメイン管理者の代理としてドメイン管理機能を実行することができます。

APIを実行するためのアクセストークンはOAuth 2.0 Client Credentials Flowによって生成されます。Client Credentialsフローを実行するために必要な認証情報は、ドメイン管理権限のあるユーザーに紐づくクライアントIDおよびシークレットです。これらの認証情報はCloudGear Accountsのドメイン設定画面より発行できます。

認証情報の発行方法

ドメイン管理権限のあるユーザーでCloudGear Accountsにアクセスします。
「ドメイン」メニューをクリックし、ドメインのダッシュボード画面を表示します。

サイドメニューの「ドメイン設定」メニューをクリックします。

 

ドメイン設定が表示されます。
「クライアント設定」セクション内の「クライアントを登録する」ボタンをクリックしてください。

 

認証情報が生成されます。
生成されたクライアントIDとシークレットを連携先アプリケーションに組み込んでください。

 

アクセストークンの仕様

クライアント認証情報を使用しClient Credentials Flowによって生成されたアクセストークンの仕様は以下の通りです。

有効期限

3600秒

要求可能スコープ

api.domain.users:read api.domain.users:write