CloudGearのAPIにリクエストを送信するには、事前にOpenID ConnectまたはOAuth 2.0 認証フローを使用してアクセストークンを取得する必要があります。

アクセストークンの取得方法は、以下の2種類になります。

Authorization Code によるアクセストークンの取得

Authorization Codeによるアクセストークンを取得するためには、サービスを利用しているユーザに認証を行っていただく必要があります。

認証に関する詳しいフローにつきましては、こちらをご覧ください。

Client Credentials によるアクセストークンの取得

Client Crendentialsによるアクセストークンを取得するためには、サービス認証の設定で作成した認証情報を使用する必要があります。

リクエスト

POST https://accounts.cloudgear.services/token

ヘッダー

キー	値

キー	値
`Content-Type`	`application/x-www-form-urlencoded`

リクエストボディ

キー	型	説明

キー	型	説明
`grant_type`	string	`client_credentials`を指定します。（固定値）
`client_id`	string	サービス認証の設定で作成したクライアントのクライアントIDを指定します。
`client_secret`	string	サービス認証の設定で作成したクライアントのクライアントシークレットを指定します。
`scope`	string	利用したいスコープを指定します。例：使用料の報告APIを利用したい場合は、`api:service:report_usage`を指定します。

サンプルリクエスト

curl https://accounts.cloudgear.services/token \
-X POST \
-d "grant_type=client_credentials" \
-d "client_id=acb390f4-b284-4a62-a07e-5791317e4783" \
-d "client_secret=secret" \
-d "scope=api:service:report_usage"

レスポンス

Content-Type： application/json

ステータスコード	メッセージ	説明

ステータスコード	メッセージ	説明
200	`access_token： <access_token>`	正常なレスポンスです。アクセストークンがレスポンスに設定されています。
400	`error： unsupported_grant_type error_description： Unsupported grant type: <client_credentials>`	grant_typeの設定値を間違えている場合のレスポンスです。
400		指定されたクライアントIDが見つからない場合のレスポンスです。

サンプルレスポンス（正常）

サンプルレスポンス（エラー）

スコープ

CloudGearのAPIにアクセスするには、APIごとに指定された追加の権限がアクセストークンに必要です。
以下のスコープをアクセストークン取得時のリクエストのscopeパラメータに指定することで、特定の権限が付与されたアクセストークンを取得できます。

スコープ	権限

スコープ	権限
`openid`	ユーザーの認証情報を要求する。
`profile`	ユーザー情報へのアクセスを要求する。
`email`	ユーザーのメールアドレスを要求する。
`offline_access`	リフレッシュトークンの返却を要求する。
`api:service:report_usage`	API経由で使用量の報告を行う。サービス認証の際は自動的に付与される。 `grant_type`が`client_credentials`の場合のみ指定できます。
`api:square:invite`	API経由でスクエアへの招待を行う。ユーザー認証の際にスコープを付与するかを選択できる。
`api:square:user_delete`	API経由でスクエアに所属しているユーザーの削除を行う。ユーザー認証の際にスコープを付与するかを選択できる。

CloudGear ドキュメント

アクセストークンの取得とスコープについて