REST実行ジョブがクラウドサービスに接続するための認証情報を設定する制御文です。
設定可能な認証種別は以下です。
BASIC認証
べアラートークン認証
AWS_SigV4認証
AzureAD認証(Oauth2.0 clientcredentials認証)
SAPクラウドサービス認証(Oauth2.0 clientcredentials認証)
プロキシサーバ認証
任意のキー、値の認証
記述形式
JSON形式、文字コードはUTF-8で記載します。データの型はAWS_SigV4認証のsigv4Headerを除き、すべてstring型で指定します。sigv4Headerはobject型で指定します。
リスト形式にすることで、複数の認証情報をまとめて登録することもできます。
以下に、認証種別ごとの記述形式について説明します。
BASIC認証の場合の制御文
BASIC認証でリクエストするときに本認証種別を選択します。
本認証種別で設定した認証情報名は、REST実行ジョブの接続情報ファイルの認証情報名パラメタで指定します。
{
"name": "認証情報名", ------(1) (*)
"authType": "認証種別", ------(2) (*)
"basicUser": "BASIC認証のユーザー名", ------(3) (*)
"basicPasswd": "BASIC認証のパスワード", ------(4) (*)
"memo": "メモ", ------(5)
"任意のキー": "任意の値" ------(6)
}(*)：必ず指定してください。
(1) name 認証情報名
登録する認証情報名を指定します。
64バイト以内で指定します。
半角英数字、“_”(半角アンダーバー)、“-”(半角ハイフン)を利用できます。ただし、先頭に“-”(半角ハイフン)は利用できません。
(2) authType 認証種別
basicを指定します。
(3) basicUser BASIC認証のユーザー名
BASIC認証の認証ユーザ名を指定します。
1024バイト以内で指定してください。
(4) basicPasswd BASIC認証のパスワード
BASIC認証の認証パスワードを指定します。
1024バイト以内で指定してください。
(5) memo メモ
登録する認証情報のメモ情報を指定します。
1024バイト以内で指定してください。
(6) 任意のキー 任意の値
REST実行ジョブに指定するクエリパラメータやHTTPリクエストヘッダの値を接続情報ファイルに直接記載したくない場合、本オペランドで任意のキーおよび値を指定します。接続情報ファイルでの本オペランドの指定方法については、“20.9.1 接続情報ファイル”を参照してください。
本オペランドはキーの名前が一意であれば複数設定できます。
任意のキー、任意の値は1024バイト以内で指定してください。
なお、任意のキーの先頭文字に“-”(半角ハイフン)は利用できません。
ベアラートークン認証の場合の制御文
ベアラートークン認証でリクエストするときに本認証種別を選択します。
本認証種別で設定した認証情報名は、REST実行ジョブの接続情報ファイルの認証情報名パラメタで指定します。
{
"name": "認証情報名", ------(1) (*)
"authType": "認証種別", ------(2) (*)
"token": "認証トークン", ------(3) (*)
"memo": "メモ", ------(4)
"任意のキー": "任意の値" ------(5)
}(*)：必ず指定してください。
(1) name 認証情報名
登録する認証情報名を指定します。
64バイト以内で指定します。
半角英数字、“_”(半角アンダーバー)、“-”(半角ハイフン)を利用できます。ただし、先頭に“-”(半角ハイフン)は利用できません。
(2) authType 認証種別
bearerを指定します。
(3) token 認証トークン
認証トークンを指定します。
(4) memo メモ
登録する認証情報のメモ情報を指定します。
1024バイト以内で指定してください。
(5) 任意のキー 任意の値
REST実行ジョブに指定するクエリパラメータやHTTPリクエストヘッダの値を、接続情報ファイルに直接記載したくない場合、本オペランドで任意のキーおよび値を指定します。接続情報ファイルでの本オペランドの指定方法については、“20.9.1 接続情報ファイル”を参照してください。
本オペランドはキーの名前が一意であれば複数設定できます。
任意のキー、任意の値は1024バイト以内で指定してください。
なお、任意のキーの先頭文字に“-”(半角ハイフン)は利用できません。
AWS_SigV4認証の場合の制御文
Amazon Web ServicesのAPIにリクエストするときに本認証種別を選択します。
AWS_SigV4認証では、アクセスキーを用いて署名バージョン4による署名を作成し、リクエストの認証情報に追加することでAmazon Web ServicesのAPIにリクエストします。
Amazon Web Servicesの署名バージョン4の詳細については、Amazon Web Servicesの公式ドキュメントを参照してください。
本認証種別で設定した認証情報名は、REST実行ジョブの接続情報ファイルの認証情報名パラメタで指定します。
{
"name": "認証情報名", ------(1) (*)
"authType": "認証種別", ------(2) (*)
"accKey": "アクセスキーID", ------(3) (*)
"secKey": "シークレットアクセスキー", ------(4) (*)
"service": "接続するサービス名", ------(5) (*)
"region": "接続するサービスのリージョン", ------(6) (*)
"endpoint": "エンドポイント", ------(7) (*)
"sigv4Header": {署名用のリクエストヘッダ}, ------(8)
"memo": "メモ", ------(9)
"任意のキー": "任意の値" ------(10)
}(*)：必ず指定してください。
(1) name 認証情報名
登録する認証情報名を指定します。
64バイト以内で指定します。
半角英数字、“_”(半角アンダーバー)、“-”(半角ハイフン)を利用できます。ただし、先頭に“-”(半角ハイフン)は利用できません。
(2) authType 認証種別
awssigv4を指定します。
(3) accKey アクセスキーID
Amazon Web ServicesのAPIを利用するためのアクセスキーIDを指定します。
(4) secKey シークレットアクセスキー
Amazon Web ServicesのAPIを利用するためのシークレットアクセスキーを指定します。
(5) service 接続するサービス名
接続するサービス名を指定します。
(例1) AWS Batchの場合：batch
(例2) AWS Lambdaの場合：lambda
各サービス名の形式については、Amazon Web Servicesの公式ドキュメントを参照してください。
(6) region 接続先のリージョン
接続先のリージョンを指定します。
(例) 東京リージョンの場合：ap-northeast-1
各リージョンの形式については、Amazon Web Servicesの公式ドキュメントを参照してください。
(7) endpoint エンドポイント
接続先のエンドポイントを指定します。
(例1) AWS Batchサービス(東京リージョン)の場合：batch.ap-northeast-1.amazonaws.com
(例2) AWS Lambdaサービス(東京リージョン)の場合：lambda.ap-northeast-1.amazonaws.com
Amazon Web ServicesのAPIエンドポイントの形式の詳細については、Amazon Web Servicesの公式ドキュメントを参照してください。
(8) sigv4Header 署名用のリクエストヘッダ
REST実行ジョブのAWS_SigV4認証では署名用のリクエストヘッダとして、“host”と“x-amz-date”を自動的に設定します。これ以外に署名に必要なリクエストヘッダがあれば、ヘッダ名：値の形式で指定します。
ヘッダ名と値は、以下のようにsigv4Headerオブジェクト内で複数指定可能です。
sigv4Header: {
ヘッダ名1:値1,
ヘッダ名2:値2,
…
}署名に必要なリクエストヘッダの形式の詳細は、Amazon Web Serviceの公式ドキュメントを参照してください。
(9) memo メモ
登録する認証情報のメモ情報を指定します。
1024バイト以内で指定してください。
(10) 任意のキー 任意の値
REST実行ジョブに指定するクエリパラメータやHTTPリクエストヘッダの値を、接続情報ファイルに直接記載したくない場合、本オペランドで任意のキーおよび値を指定します。接続情報ファイルでの本オペランドの指定方法については、“20.9.1 接続情報ファイル”を参照してください。
本オペランドはキーの名前が一意であれば複数設定できます。
任意のキー、任意の値は1024バイト以内で指定してください。
なお、任意のキーの先頭文字に“-”(半角ハイフン)は利用できません。
AzureAD認証(Oauth2.0 clientcredentials認証)の場合の制御文
AzureのAPIにリクエストするときに本認証種別を選択します。
AzureAD認証では、Oauth2.0のclientcredentialsフローでの認証を実施します。
本認証種別で設定した認証情報名は、REST実行ジョブの接続情報ファイルの認証情報名パラメタで指定します。
{
"name": "認証情報名", ------(1) (*)
"authType": "認証種別", ------(2) (*)
"clientId": "クライアントID", ------(3) (*)
"clientSecret": "クライアントシークレット", ------(4) (*)
"endpoint": "エンドポイント", ------(5) (*)
"resource": "リソース", ------(6) (*)
"memo": "メモ", ------(7)
"任意のキー": "任意の値" ------(8)
}(*)：必ず指定してください。
(1) name 認証情報名
登録する認証情報名を指定します。
64バイト以内で指定します。
半角英数字、“_”(半角アンダーバー)、“-”(半角ハイフン)を利用できます。ただし、先頭に“-”(半角ハイフン)は利用できません。
(2) authType 認証種別
azureadを指定します。
(3) clinetId クライアントID
Oauth2.0認証のクライアントIDを指定します。
クライアントIDの形式の詳細については、Azureの公式ドキュメントを参照してください。
(4) clinetSecret クライアントシークレット
Oauth2.0認証のクライアントシークレットを指定します。
クライアントシークレットの形式の詳細については、Azureの公式ドキュメントを参照してください。
(5) endpoint エンドポイント
Oauth2.0認証のエンドポイントを指定します。
アクセストークン取得先のURLを以下のように指定します。
例） https://login.microsoftonline.com/<テナントID>/oauth2/token
エンドポイントの形式の詳細については、Azureの公式ドキュメントを参照してください。
(6) resource リソース
Oauth2.0認証のリソースを指定します。
リソースの形式の詳細については、Azureの公式ドキュメントを参照してください。
(7) memo メモ
登録する認証情報のメモ情報を指定します。
1024バイト以内で指定してください。
(8) 任意のキー 任意の値
REST実行ジョブに指定するクエリパラメータやHTTPリクエストヘッダの値を接続情報ファイルに直接記載したくない場合、本オペランドで任意のキーおよび値を指定します。接続情報ファイルでの本オペランドの指定方法については、“20.9.1 接続情報ファイル”を参照してください。
本オペランドはキーの名前が一意であれば複数設定できます。
任意のキー、任意の値は1024バイト以内で指定してください。
なお、任意のキーの先頭文字に“-”(半角ハイフン)は利用できません。
SAPクラウドサービス認証(Oauth2.0 clientcredentials認証)の場合の制御文
SAP Job Scheduling サービスのAPIに、Oauth2.0認証でリクエストするときに本認証種別を選択します。
SAPクラウドサービス認証では、Oauth2.0 の clientcredentialsフローでの認証を実施します。
本認証種別で設定した認証情報名は、REST実行ジョブの接続情報ファイルの認証情報名パラメタで指定します。
{
"name": "認証情報名", ------(1) (*)
"authType": "認証種別", ------(2) (*)
"clientId": "クライアントID", ------(3) (*)
"clientSecret": "クライアントシークレット", ------(4) (*)
"endpoint": "エンドポイント", ------(5) (*)
"memo": "メモ" ------(6)
}(*)：必ず指定してください。
(1) name 認証情報名
登録する認証情報名を指定します。
64バイト以内で指定します。
半角英数字、“_”(半角アンダーバー)、“-”(半角ハイフン)を利用できます。ただし、先頭に“-”(半角ハイフン)は利用できません。
(2) authType 認証種別
scsを指定します。
(3) clinetId クライアントID
Oauth2.0認証のクライアントIDを指定します。
クライアントIDの形式の詳細については、SAPクラウドサービスの公式ドキュメントを参照してください。
(4) clinetSecret クライアントシークレット
Oauth2.0認証のクライアントシークレットを指定します。
クライアントシークレットの形式の詳細については、SAPクラウドサービスの公式ドキュメントを参照してください。
(5) endpoint エンドポイント
Oauth2.0認証のエンドポイントを指定します。
アクセストークン取得先のURLを以下のように指定します。
例） https://cfazure.authentication.<リージョン>.hana.ondemand.com/oauth/token
エンドポイントの形式の詳細については、SAPクラウドサービスの公式ドキュメントを参照してください。
(6) memo メモ
登録する認証情報のメモ情報を指定します。
1024バイト以内で指定してください。
プロキシサーバ認証を設定する場合の制御文
プロキシサーバ経由でHTTPリクエストする場合、本認証種別でプロキシサーバ認証用の情報を設定します。
本認証種別で設定した認証情報名は、REST実行ジョブの接続情報ファイルのプロキシサーバの認証情報名パラメタで指定します。
{
"name": "認証情報名", ------(1) (*)
"authType": "認証種別", ------(2) (*)
"proxyAddress": "プロキシサーバのアドレス", ------(3) (*)
"proxyPort": "プロキシサーバのポート番号", ------(4) (*)
"proxyUser": "プロキシサーバの認証ユーザ名", ------(5)
"proxyPasswd": "プロキシサーバの認証パスワード", ------(6)
"memo": "メモ" ------(7)
}(*)：必ず指定してください。
(1) name 認証情報名
登録する認証情報名を指定します。
64バイト以内で指定します。
半角英数字、“_”(半角アンダーバー)、“-”(半角ハイフン)を利用できます。ただし、先頭に“-”(半角ハイフン)は利用できません。
(2) authType 認証種別
proxyを指定します。
(3) proxyAddress プロキシサーバのアドレス
プロキシサーバのアドレスを指定します。
1024バイト以内で指定してください。
(4) proxyPort プロキシサーバのポート番号
プロキシサーバのポート番号を指定します。
0～65535の間で指定してください。
(5) proxyUser プロキシサーバの認証ユーザ名
プロキシサーバの認証ユーザ名を指定します。
1024バイト以内で指定してください。
プロキシサーバの認証パスワードが指定されている場合は、必ず指定してください。
(6) proxyPasswd プロキシサーバの認証パスワード
プロキシサーバの認証パスワードを指定します。
1024バイト以内で指定してください。
プロキシサーバの認証ユーザ名が指定されている場合は、必ず指定してください。
(7) memo メモ
登録する認証情報のメモ情報を指定します。
1024バイト以内で指定してください。
任意のキー、値の認証を設定する場合の制御文
他の認証種別による認証を実施しない、かつ、REST実行ジョブに指定するクエリパラメータやHTTPリクエストヘッダ、HTTPリクエストボディの値を接続情報ファイルに直接記載したくない場合は、本認証種別で任意のキーおよび値を設定できます。
本認証種別で設定した認証情報名は、REST実行ジョブの接続情報ファイルの認証情報名パラメタで指定します。
{
"name": "認証情報名", ------(1) (*)
"authType": "認証種別", ------(2) (*)
"memo": "メモ", ------(3)
"任意のキー": "任意の値" ------(4)
}(*)：必ず指定してください。
(1) name 認証情報名
登録する認証情報名を指定します。
64バイト以内で指定します。
半角英数字、“_”(半角アンダーバー)、“-”(半角ハイフン)を利用できます。ただし、先頭に“-”(半角ハイフン)は利用できません。
(2) authType 認証種別
othersを指定します。
(3) memo メモ
登録する認証情報のメモ情報を指定します。
1024バイト以内で指定してください。
(4) 任意のキー 任意の値
任意のキーおよび値を指定します。接続情報ファイルでの本オペランドの指定方法については、“20.9.1 接続情報ファイル”を参照してください。本オペランドはキーの名前が一意であれば複数設定できます。
任意のキー、任意の値は1024バイト以内で指定してください。なお、任意のキーの先頭文字に“-”(半角ハイフン)は利用できません。