2.6.2 アクセスルール設定支援機能

アクセスルール設定支援機能では、以下のWeb APIを提供します。

機能名	概要
ルール登録API	アクセスルールを新規登録する際に用いるWeb APIです。
ルール更新API	登録済みのアクセスルールを更新する際に用いるWeb APIです。
ルール取得API	登録済みのアクセスルールを参照する際に用いるWeb APIです。
ルール削除API	登録済みのアクセスルールを削除する際に用いるWeb APIです。
ユーザー一覧取得API	特定の情報区分コードに対しアクセスルールを登録しているユーザー名の一覧を取得する際に用いるWeb APIです。
情報区分コード取得API	特定のユーザーが登録しているアクセスルールの情報区分コード一覧を取得する際に用いるWeb APIです。
アクセスルール間の衝突回避機能	本版では、管理者が作成したアクセスルールとデータ登録者が作成したアクセスルールで優先順位を設けており、データ登録者が作成したアクセスルールを優先しています。

ポイント

アクセスルールを編集する画面からは、編集したルールをファイル(JSON)に保存することができます。保存したルールファイル(JSON)はAPIを使用して登録することができます。

参照

アクセスルールの書式については、“付録B 定義ファイル”を参照してください。

注意

アクセスルール設定支援機能を使用する場合は、“2.7 アクセスルール承認機能”を使用しないでください。

2.6.2.1 ルール登録API

2.6.2.1.1 概要

アクセスルールを新規登録する際に用いるWeb APIです。

2.6.2.1.2 リクエスト設計

リクエストフォーマット

項目		値	備考
APIエンドポイント (相対URI)		/webapi/v1/policymgr/policy
HTTPメソッド		POST
HTTPリクエストヘッダ	Content-Type	application/json
HTTPリクエストボディ		アクセスルール	アクセスルールのファイルを指定します。文字エンコードはUTF-8です。

例)

curl -i -s -XPOST -H "Content-Type: application/json" -d @data.json http://<開発実行環境サーバのIPアドレス>:<ポート番号(注)>/webapi/v1/policymgr/policy

注)インベントリファイルのaccess_policy_mngr_portに設定した値を指定

参照

Apache Tomcatに配備されたAPIエンドポイント(相対URI)は、Apache Tomcatの設定により異なります。

Apache Tomcatに配備されたAPIエンドポイント(相対URI)の確認方法については、Apache Tomcatのオンラインマニュアルなどを参照してください。

2.6.2.1.3 レスポンス設計

レスポンスフォーマット

項目		値	備考
HTTPステータス		int(3桁)	正常時200または204、異常時は後述
HTTPレスポンスヘッダ	Date	日付
	Proxy-Connection	Keep-Alive
	Connection	Keep-Alive
	X-BlueCoat-Authorization	文字列
HTTPレスポンスボディ		ワーニングメッセージ	以下の条件時、HTTPステータスに200を設定してワーニングメッセージを出力する。 ● アクセスルールの有効期限に隙間の期間がある場合 ● アクセスルールの終了期限が現在日時よりも前の場合アクセスルールの有効期限に重なった期間がある場合はワーニングではなくエラーとなる。

例)

HTTP/1.1 204 
Date: Fri, 07 Jan 2022 09:37:37 GMT
Proxy-Connection: Keep-Alive
Connection: Keep-Alive
X-BlueCoat-Authorization: 85bc5b1f65b6f3c7=304776EA00000003VrFwPeZ0m0iGMvBr/4UYk2KRC1IsCwAAAwAAACNvqQAIBwAAAAAAACFragAAAAAA

HTTPステータスコード

HTTPステータスコード	利用場面
200	アクセスルールの新規登録成功(ワーニングメッセージあり)
204	アクセスルールの新規登録成功
400	入力されたアクセスルールの形式が不正
409	すでに同じ情報区分コード、オーナーのアクセスルールが登録されている
500	サーバサイドで内部エラー発生

2.6.2.1.4 メッセージボディ

HTTPステータスコード	メッセージボディ
204	リクエストが成功してリソースの作成が完了したことをHTTPステータスで表示
400/500番台	エラーメッセージをHTML形式で表示

2.6.2.1.5 キャッシュ

POSTメソッドを用いるため無効です。

2.6.2.1.6 注意事項

2.6.2.2 ルール更新API

2.6.2.2.1 概要

登録済みのアクセスルールを更新する際に用いるWeb APIです。

2.6.2.2.2 リクエスト設計

リクエストフォーマット

項目		値	備考
APIエンドポイント (相対URI)		/webapi/v1/policymgr/policy
HTTPメソッド		PUT
HTTPリクエストヘッダ	Content-Type	application/json
HTTPリクエストボディ		アクセスルール	アクセスルールのファイルを指定します。文字エンコードはUTF-8です。

例)

curl -i -s -XPUT -H "Content-Type: application/json" -d @data.json http://<開発実行環境サーバのIPアドレス>:<ポート番号(注)>/webapi/v1/policymgr/policy

注)インベントリファイルのaccess_policy_mngr_portに設定した値を指定

参照

Apahe Tomcatに配備されたAPIエンドポイント(相対URI)は、Apache Tomcatの設定により異なります。

Apache Tomcatに配備されたAPIエンドポイント(相対URI)の確認方法については、Apache Tomcatのオンラインマニュアルなどを参照してください。

2.6.2.2.3 レスポンス設計

レスポンスフォーマット

項目		値	備考
HTTPステータス		int(3桁)	正常時200または204、異常時は後述
HTTPレスポンスヘッダ	Date	日付
	Proxy-Connection	Keep-Alive
	Connection	Keep-Alive
	X-BlueCoat-Authorization	文字列
HTTPレスポンスボディ		ワーニングメッセージ	以下の条件時、HTTPステータスに200を設定してワーニングメッセージを出力する。 ● アクセスルールの有効期限に隙間の期間がある場合 ● アクセスルールの終了期限が現在日時よりも前の場合アクセスルールの有効期限に重なった期間がある場合はワーニングではなくエラーとなる。

例)

HTTP/1.1 204 
Date: Fri, 07 Jan 2022 12:16:15 GMT
Proxy-Connection: Keep-Alive
Connection: Keep-Alive
X-BlueCoat-Authorization: 387545aa7411cb70=30477AD500000003Uk/6dldpyaY9b9jSBei+myDVDu43CwAAAwAAADaQqQAIBwAAAAAAAKTraQAAAAAA

HTTPステータスコード

HTTPステータスコード	利用場面
200	アクセスルールの更新成功(ワーニングメッセージあり)
204	アクセスルールの更新成功
400	入力されたアクセスルールの形式が不正
404	既存のアクセスルールが存在しない
500	サーバサイドで内部エラー発生

2.6.2.2.4 メッセージボディ

HTTPステータスコード	メッセージボディ
204	リクエストが成功してリソースの作成が完了したことをHTTPステータスで表示
400/500番台	エラーメッセージをHTML形式で表示

2.6.2.2.5 キャッシュ

2.6.2.2.6 注意事項

2.6.2.3 ルール取得API

2.6.2.3.1 概要

登録済みのアクセスルールを参照する際に用いるWeb APIです。

2.6.2.3.2 リクエスト設計

リクエストフォーマット

項目		値		備考
APIエンドポイント (相対URI)		/webapi/v1/policymgr/policy
クエリパラメータ	code	必須	情報区分コード	4桁までの任意の値(数字文字列)であること
クエリパラメータ	user	必須	オーナー名	UTF-8文字列を%エンコードしたもの管理者登録のアクセスルールを指定する場合は “.”(ピリオド)を指定
HTTPメソッド		GET

例)

curl -i -s -XGET "http://<開発実行環境サーバのIPアドレス>:<ポート番号(注)>/webapi/v1/policymgr/policy?user=User01@bdisvtesttenant.onmicrosoft.com&code=3012"

(注)インベントリファイルのaccess_policy_mngr_portに設定した値を指定

参照

Apache Tomcatに配備されたAPIエンドポイント(相対URI)は、Apache Tomcatの設定により異なります。

Apache Tomcatに配備されたAPIエンドポイント(相対URI)の確認方法については、Apache Tomcatのオンラインマニュアルなどを参照してください。

2.6.2.3.3 レスポンス設計

レスポンスフォーマット

項目		値	備考
HTTPステータス		int(3桁)	正常時200、異常時は後述
HTTPレスポンスヘッダ	Content-Type	application/json
	Content-Length	int
	Date	日付
	Proxy-Connection	Keep-Alive
	Connection	Keep-Alive
	X-BlueCoat-Authorization	文字列
HTTPレスポンスボディ		アクセスルール一覧	アクセスルールのJSON文字列。文字エンコードはUTF-8

例)

HTTP/1.1 200 
Content-Type: application/json
Content-Length: 755
Date: Fri, 07 Jan 2022 11:11:49 GMT
Proxy-Connection: Keep-Alive
Connection: Keep-Alive
X-BlueCoat-Authorization: ca5a4f8a2087af4f=30744BB600000003F7HIv+du2u3v6ueTbgQa9sRg38EpCAAAAwAAAMd8qQAIBwAAAAAAALQfRAAAAAAA

{"meta_info":{"policy":{"master":false,"producer":"User01@bdisvtesttenant.onmicrosoft.com"},"resource":{"code":"3012","message_name":"運送計画情報","target_notation":"xpath"},"version":"1.0"},"permission":{"categories":[{"crud":{"create":[],"delete":[],"read":["/運送計画情報/メッセージ情報/@データ処理NO."],"update":[]},"name":"食品卸"},{"crud":{"create":[],"delete":[],"read":["/運送計画情報/メッセージ情報/@情報区分コード"],"update":[]},"name":"配送業者"}],"crud":{"create":[],"delete":[],"read":[],"update":[]},"users":[{"crud":{"create":[],"delete":[],"read":["*"],"update":[]},"name":"User01@bdisvtesttenant.onmicrosoft.com"},{"crud":{"create":[],"delete":[],"read":["/運送計画情報/メッセージ情報/@データ処理NO."],"update":[]},"name":"User02@bdisvtesttenant.onmicrosoft.com"}]}}

HTTPステータスコード

HTTPステータスコード	利用場面
200	アクセスルールの取得成功
400	入力されたパラメータの形式が不正
404	指定されたアクセスルールが存在しない
500	サーバサイドで内部エラー発生

2.6.2.3.4 メッセージボディ

HTTPステータスコード	メッセージボディ
200	リクエストが成功してリソースの作成が完了したことをHTTPステータスで表示
400/500番台	エラーメッセージをHTML形式で表示

2.6.2.3.5 キャッシュ

2.6.2.3.6 注意事項

2.6.2.4 ルール削除API

2.6.2.4.1 概要

登録済みのアクセスルールを削除する際に用いるWeb APIです。

2.6.2.4.2 リクエスト設計

リクエストフォーマット

項目		値		備考
APIエンドポイント (相対URI)		/webapi/v1/policymgr/policy
クエリパラメータ	code	必須	情報区分コード	4桁までの任意の値(数字文字列)であること
クエリパラメータ	user	必須	オーナー名	UTF-8文字列を%エンコードしたもの管理者登録のアクセスルールを指定する場合は “.”(ピリオド)を指定
HTTPメソッド		DELETE

例)

curl -i -s -XDELETE "http://<開発実行環境サーバのIPアドレス>:<ポート番号(注)>/webapi/v1/policymgr/policy?user=User01@bdisvtesttenant.onmicrosoft.com&code=3012"

注)インベントリファイルのaccess_policy_mngr_portに設定した値を指定

参照

Apache Tomcatに配備されたAPIエンドポイント(相対URI)は、Apache Tomcatの設定により異なります。

Apache Tomcatに配備されたAPIエンドポイント(相対URI)の確認方法については、Apache Tomcatのオンラインマニュアルなどを参照してください。

2.6.2.4.3 レスポンス設計

レスポンスフォーマット

項目		値	備考
HTTPステータス		int(3桁)	正常時204、異常時は後述
HTTPレスポンスヘッダ	Date	日付
	Proxy-Connection	Keep-Alive
	Connection	Keep-Alive
	X-BlueCoat-Authorization	文字列

例)

HTTP/1.1 204 
Date: Fri, 07 Jan 2022 10:09:55 GMT
Proxy-Connection: Keep-Alive
Connection: Keep-Alive
X-BlueCoat-Authorization: ca5a4f8a2087af4f=30744BB600000003GVmy7Xk1lBix6BDkOABXSpgcNmooCAAAAwAAAEZuqQAIBwAAAAAAABEYRAAAAAAA

HTTPステータスコード

HTTPステータスコード	利用場面
204	アクセスルールの削除成功
400	入力されたパラメータの形式が不正
404	指定されたアクセスルールが存在しない
500	サーバサイドで内部エラー発生

2.6.2.4.4 メッセージボディ

HTTPステータスコード	メッセージボディ
204	リクエストが成功してリソースの作成が完了したことをHTTPステータスで表示
400/500番台	エラーメッセージをHTML形式で表示

2.6.2.4.5 キャッシュ

2.6.2.4.6 注意事項

2.6.2.5 ユーザー一覧取得API

2.6.2.5.1 概要

特定の情報区分コードに対しアクセスルールを登録しているユーザー名の一覧を取得する際に用いるWeb APIです。

2.6.2.5.2 リクエスト設計

リクエストフォーマット

項目		値		備考
APIエンドポイント (相対URI)		/webapi/v1/policymgr/policy/users
クエリパラメータ	code	必須	情報区分コード	4桁までの任意の値(数字文字列)であること
HTTPメソッド		GET

例)

curl -i -s -XGET "http://<開発実行環境サーバのIPアドレス>:<ポート番号(注)>/webapi/v1/policymgr/policy/users?code=3012"

注)インベントリファイルのaccess_policy_mngr_portに設定した値を指定

参照

Apache Tomcatに配備されたAPIエンドポイント(相対URI)は、Apache Tomcatの設定により異なります。

Apache Tomcatに配備されたAPIエンドポイント(相対URI)の確認方法については、Apache Tomcatのオンラインマニュアルなどを参照してください。

2.6.2.5.3 レスポンス設計

レスポンスフォーマット

項目		値	備考
HTTPステータス		int(3桁)	正常時200、異常時は後述
HTTPレスポンスヘッダ	Content-Type	application/json
	Content-Length	int
	Date	日付
	Proxy-Connection	Keep-Alive
	Connection	Keep-Alive
	X-BlueCoat-Authorization	文字列
HTTPレスポンスボディ		ユーザー名一覧	指定された情報区分コードのアクセスルールを登録しているユーザー名のJSON配列

例)

HTTP/1.1 200 
Content-Type: application/json
Content-Length: 9
Date: Fri, 07 Jan 2022 11:41:41 GMT
Proxy-Connection: Keep-Alive
Connection: Keep-Alive
X-BlueCoat-Authorization: 387545aa7411cb70=30477AD5000000037uof+Q7qf1jxReBnE1NVEQzi6802CwAAAwAAAByIqQAIBwAAAAAAAKTraQAAAAAA

["User01@bdisvtesttenant.onmicrosoft.com"]

HTTPステータスコード

HTTPステータスコード	利用場面
200	ユーザー名の一覧取得成功
400	入力されたパラメータの形式が不正
404	指定されたアクセスルールが存在しない
500	サーバサイドで内部エラー発生

2.6.2.5.4 メッセージボディ

HTTPステータスコード	メッセージボディ
200	リクエストが成功してリソースの作成が完了したことをHTTPステータスで表示
400/500番台	エラーメッセージをHTML形式で表示

2.6.2.5.5 キャッシュ

2.6.2.5.6 注意事項

2.6.2.6 情報区分コード取得API

2.6.2.6.1 概要

特定のユーザーが登録しているアクセスルールの情報区分コード一覧を取得する際に用いるWeb APIです。

2.6.2.6.2 リクエスト設計

リクエストフォーマット

項目	値	備考
APIエンドポイント (相対URI)	/webapi/v1/policymgr/policy/codes
クエリパラメータ	user	必須	オーナー名	UTF-8文字列を%エンコードしたもの管理者登録のアクセスルールを指定する場合は“.”(ピリオド)を指定
HTTPメソッド		GET

項目

値

備考

APIエンドポイント (相対URI)

/webapi/v1/policymgr/policy/codes

クエリパラメータ

user

必須

オーナー名

UTF-8文字列を%エンコードしたもの

管理者登録のアクセスルールを指定する場合は“.”(ピリオド)を指定

HTTPメソッド

GET

例)

curl -i -s -XGET "http://<開発実行環境サーバのIPアドレス>:<ポート番号(注)>/webapi/v1/policymgr/policy/codes?user=User01@bdisvtesttenant.onmicrosoft.com"

注)インベントリファイルのaccess_policy_mngr_portに設定した値を指定

参照

Apache Tomcatに配備されたAPIエンドポイント(相対URI)は、Apache Tomcatの設定により異なります。

Apache Tomcatに配備されたAPIエンドポイント(相対URI)の確認方法については、Apache Tomcatのオンラインマニュアルなどを参照してください。

2.6.2.6.3 レスポンス設計

レスポンスフォーマット

項目		値	備考
HTTPステータス		int(3桁)	正常時200、異常時は後述
HTTPレスポンスヘッダ	Content-Type	application/json
	Content-Length	int
	Date	日付
	Proxy-Connection	Keep-Alive
	Connection	Keep-Alive
	X-BlueCoat-Authorization	文字列
HTTPレスポンスボディ		情報区分コード一覧	指定されたユーザーが登録しているアクセスルールの情報区分コード(数値)のJSON配列

例)

HTTP/1.1 200 
Content-Type: application/json
Content-Length: 8
Date: Fri, 07 Jan 2022 11:58:20 GMT
Proxy-Connection: Keep-Alive
Connection: Keep-Alive
X-BlueCoat-Authorization: ca5a4f8a2087af4f=30744BB600000003UqTBFlT1KpMs2ZPgIcW6wSbc9A8qCAAAAwAAAK+HqQAIBwAAAAAAALQfRAAAAAAA

["3012"]

HTTPステータスコード

HTTPステータスコード	利用場面
200	情報区分コードの一覧取得成功
400	入力されたパラメータの形式が不正
404	指定されたアクセスルールが存在しない
500	サーバサイドで内部エラー発生