1. API認証 API

1.1. 接続情報

Host

auth-api.jp-east-1.paas.cloud.global.fujitsu.com

各APIはHTTPSで提供する。
URL例
https://auth-api.jp-east-1.paas.cloud.global.fujitsu.com/API/oauth2/token

1.2. POST /API/oauth2/token

Description

アクセストークンを取得するインターフェース。 既に取得済みの有効期間内のアクセストークンが存在する場合、新たなアクセストークンは払い出さずに取得済みの有効なアクセストークンが返却される。 なお、本APIは5回以上連続でアクセストークン取得に失敗した場合、その取得対象のクライアントＩＤに対するアクセストークン取得は30分ロックする。

Request Header
Name Type Description

Content-Type

String

"application/x-www-form-urlencoded;charset=UTF-8"　を指定する。
Request Parameter

なし

Body
grant_type=client_credentials&scope=service_contract&client_id=your-id&client_secret=your-password
Name Type Required Description

grant_type

String

Yes

"client_credentials"を指定する。

scope

String

Yes

"service_contract"を指定する。

client_id

String

Yes

認証対象のクライアントＩＤ。

client_secret

String

Yes

クライアントＩＤに対するパスワード。
Return Codes
Code Description

201

アクセストークン生成が正常に終了。

400 ※認証エラー時

invalid_request : 入力パラメータが不正。

400 ※認証エラー時

unsupported_grant_type : grant_typeに"client_credentials"ではない値を指定。

400 ※認証エラー時

invalid_scope : scopeに"service_contract"ではない値を指定。

400 ※認証エラー時

invalid_request : 入力パラメータが不正。

400 ※認証エラー時

invalid_client : 認証失敗。指定されたクライアントＩＤ、パスワードを見直しが必要。

400

RCM403102 : Content-Typeが未指定。

400

RCM403103 : 使用することができないContent-Typeを指定。

400

RCM403105 : URLデコードできないパラメータを指定。

400

RCM403106 : 数値フィールドに数値以外の値を指定。

500

RCM102205 : システム管理者にお問い合わせください。

500

RCM053104 : システム管理者にお問い合わせください。
Response Header
Name Type Description

Content-Type

String

"application/x-www-form-urlencoded;charset=UTF-8"　が指定される。
Response Parameter

  • レスポンス（正常）

 {
     "access_token":"5f744f66-56d9-4c8c-87b2-c870f3b82817",
     "token_type":"bearer",
     "expires_in":1124,
     "scope":"service_contract",
     "client_id":"your-id",
     "contract_info":{
         "contract_list":[
             {
                 "service_contract_id":"...",
                 "service_code":"..."
             }
         ]
     }
 }
Name Type Description

access_token

String

払い出されたアクセストークン。

token_type

String

"bearer"が指定される。

expires_in

long

トークンの有効期間。トークンの新規発行時は1799(秒)となる。

scope

String

"service_contract"が指定される。

client_id

String

このトークンを払い出したクライアントＩＤ。

contract_info

object

トークンを払い出したクライアントＩＤの契約情報。

contract_list

array

クライアントＩＤに紐づいた契約一覧。

service_contract_id

String

サービス契約ＩＤ。

service_code

String

サービスコード。

  • レスポンス（異常）　※認証エラー時

{
     "error":"invalid_client",
     "error_description":"指定された情報によってアクセストークンを払い出すことはできません。"
 }
Name Type Description

error

String

エラーコード。エラーコードの意味については、OAuth2.0におけるエラーコードについてを参照。

error_description

String

エラーコードの追加情報。文字列末尾に応答エラーコードに相当するコードが付与されので、エラー発生時はHTTPステータスコード・応答エラーコード一覧を参照。

  • レスポンス（異常）　※認証エラー以外
    共通レスポンス（異常）を参照。

1.3. POST /API/oauth2/token?access_token={access_token}

Description

アクセストークンを取得するを用いて取得したアクセストークンを破棄する。

Request Header

なし

Request Parameter
{access_token} = 払い出されたアクセストークン
Body

なし

Return Codes
Code Description

204

指定されたアクセストークンは有効な状態ではない。

400

RCM402301 : 入力パラメータが不正。

500

RCM102302 : システム管理者にお問い合わせください。

500

予期せぬエラーが発生。
Response Header

なし

Response Parameter

  • レスポンス（正常）
    なし

  • レスポンス（異常）
    共通レスポンス（異常）を参照。

1.4. OAuth2.0におけるエラーコードについて

OAuth2.0が規定するエラーコードが示す意味は以下になる。

Code Description

invalid_request

リクエストに必要なパラメーターが含まれていない、サポートされない(グラントタイプ以外の)パラメーター値が含まれている、パラメーターが重複している、複数のクレデンシャルが含まれている、クライアント認証のための複数のメカニズムが利用されている、もしくは異常値が設定されている。

invalid_client

クライアント認証に失敗した(例: 未知のクライアントである、クライアント認証情報が含まれていない、サポートされない認証方式が利用されている)。

invalid_grant

提供された認可グラント(例えば認可コード、リソースオーナークレデンシャル)またはリフレッシュトークンが不正、有効期限切れ、失効している、認可リクエストで用いられたリダイレクトURIとマッチしていない、他のクライアントに対して発行されたものである。

unauthorized_client

認証されたクライアントが当該のグラントタイプを利用する様に認可されていない。

unsupported_grant_type

グラントタイプが認可サーバーによってサポートされていない。

invalid_scope

要求されたスコープが不正、未知、異常、リソースオーナーによって与えられた範囲を超えている。

戻る