アプリケーションプログラミングインターフェースガイド> REST API> TDVサーバーREST API> Security API
 
Security(セキュリティ)API
次のセキュリティオペレーションを実行できます。
GET /backup_encryption_settings
GET /systemEncryption
GET /domains
GET /domains/groups
POST/domains/groups/sync
GET /backup_encryption_settings
GET /domains/domain_users
GET /generateUUID
GET /systemEncryption
PUT /systemEncryption
GET /backup_encryption_settings
このAPIは、緊急時にサーバーを回復できるように、暗号化設定をパスワードで保護されたファイルにバックアップするために使用されます。
パラメーター:
名前
説明
パラメータータイプ
データタイプ
encryptionPassword
Encryption Password(暗号化パスワード)
query
string
暗号化設定をバックアップする例
curl -X GET -u admin:admin "http://localhost:9400/rest/security/v1/backup_encryption_settings?encryptionPassword=testPassword" -o backup_encryption_settings.txt
POST /import_encryption_settings
このAPIは、バックアップファイルから暗号化設定を復元するために使用されます。バックアップファイルを保護するために使用されたパスワードが分かっている必要があります。
パラメーター:
名前
説明
パラメータータイプ
データタイプ
file
インポートするファイルの名前
query
object
encryptionPassword
Encryption Password(暗号化パスワード)
query
string
暗号化設定を復元する例
curl -u "admin:admin" -i -F "encryptionPassword=testPassword" -F "file=@backup_encryption_settings.txt" -X POST "http://localhost:9400/rest/security/v1/import_encryption_settings"
GET /domains
このAPIは、すべてのドメインを取得するために使用されます。
パラメーター:
なし
すべてのドメインを取得する例
curl -X GET -u admin:admin "http://localhost:9400/rest/security/v1/domains"
GET /domains/groups
このAPIは、すべてのドメイングループを取得するために使用されます。
パラメーター:
名前
説明
パラメータータイプ
データタイプ
domain
ドメインの名前
path
string
すべての「複合」ドメイングループを取得する例
curl -X GET -u admin:admin "http://localhost:9400/rest/security/v1/domains/composite/groups"
POST/domains/groups/sync
このAPIは、外部LDAPドメインのすべての外部LDAPドメイングループ内の特定のユーザーを同期するために使用されます。
パラメーター
名前
説明
パラメータータイプ
データタイプ
domain
ドメインの名前
path
string
リクエスト本文
値の例-スキーマ
[
"string"
]
「ldap」ドメインユーザー「user1」と「user2」のグループを同期する例
curl -X POST "https://localhost:9402/rest/security/v1/domains/ldap/groups/sync" -H "accept: */*" -H "Content-Type: application/json" -d "[\"user1\",\"user2\"]"
GET /domains/domain_users
このAPIは、すべてのドメインユーザーを取得するために使用されます。
パラメーター:
名前
説明
パラメータータイプ
データタイプ
domain
ドメインの名前
path
string
すべての「複合」ドメインユーザーを取得する例
curl -X GET -u admin:admin "http://localhost:9400/rest/security/v1/domains/composite/users"
GET /generateUUID
このAPIは、ランダムに生成されたシステムUUIDを取得するために使用されます。
パラメーター:
なし
システムでランダムに生成されたUUIDを取得する例
curl -X GET -u admin:admin "http://localhost:9400/rest/security/v1/generateUUID"
GET /systemEncryption
このAPIは、システムの暗号化設定を取得するために使用されます。
パラメーター:
なし
システムの暗号化設定を取得する例
curl -X GET -u admin:admin "http://localhost:9400/rest/security/v1/systemEncryption"
PUT /systemEncryption
このAPIは、システムの暗号化設定を更新するために使用されます。大規模なデータベースでは、データを再暗号化するのに長い時間がかかる場合があります。
パラメーター:
名前
説明
パラメータータイプ
データタイプ
body
暗号化設定(アルゴリズム、パスワード、uuid、キーサイズ
body
Model schema
リクエスト本文
値の例-スキーマ
{
“algorithm”: "string",
“password”: “string”,
“uuid”: “string”,
“keySize”: “string”
]
システムの暗号化設定を更新する例
curl -X PUT -u admin:admin "http://localhost:9400/rest/security/v1/systemEncryption" -H "Content-Type:application/json" -d "{\"password\":\"MyTestEncryptionPassword\",\"uuid\":\"0b352e1e-ab56-4271-a813-31183df63788\"}"