移動

• リクエスト
• レスポンス
• 例

LDAP構成のテスト

post

/api/v1/configuration/ldapConfig/test

指定したLDAP構成をテストします。

リクエスト

サポートされるメディア・タイプ

• application/json

本文()

LDAP構成の詳細

ルート・スキーマ: LdapConfigDetail

型: object

LDAP構成の詳細

ソースの表示

• backupHosts: array backupHosts
  ADのバックアップ・ドメイン・コントローラのリスト。
• bpmUserGroup: string
  このグループのメンバーシップを持つユーザーは、Blockchain Platform Manager (このコンソール)にログインして完全アクセス権を持つことができ、Blockchain Platformインスタンスに対してライフ・サイクル操作を実行できます。ADにのみ必要です。
• caAdminGroup: string
  このグループのユーザーには、他のユーザーを登録する権限があります。新しいBlockchain Platformインスタンスを作成するには、CA管理者権限も必要です。ADにのみ必要です。
• connectTimeout: integer
• groupClassName: string
• groupMembershipAttribute: string
• groupNameAttribute: string
• instanceAdminGroup: string
  このグループのメンバーシップを持つユーザーは、インスタンス・コンソールへの完全なアクセス権を持ち、UIまたはREST APIを使用してそのコンソールですべての操作を実行できます。ADにのみ必要です。
• instanceUserGroup: string
  このグループのメンバーシップを持つユーザーは、UIまたはREST APIを使用してインスタンス・コンソールを表示できます。他の操作は実行できません。ADにのみ必要です。
• ldapBaseDN: string
• ldapBindDN: string
• ldapBindPassword: string
• ldapHost: string
• ldapId: string
• ldapName: string
• ldapPort: integer
• ldapTLSCACert: string
• ldapTLSEnabled: boolean
• ldapType: string
• restProxyGroup: string
  このグループのメンバーシップを持つユーザーは、REST APIを使用してインスタンスと対話できます。ADにのみ必要です。
• tlsRootCACertFileName: string
• userClassName: string
• userNameAttribute: string

{
    "description":"LDAP Configuration details",
    "type":"object",
    "properties":{
        "ldapId":{
            "type":"string"
        },
        "ldapName":{
            "type":"string"
        },
        "ldapType":{
            "type":"string"
        },
        "ldapHost":{
            "type":"string"
        },
        "ldapPort":{
            "type":"integer"
        },
        "ldapTLSEnabled":{
            "type":"boolean"
        },
        "ldapTLSCACert":{
            "type":"string"
        },
        "ldapBaseDN":{
            "type":"string"
        },
        "ldapBindDN":{
            "type":"string"
        },
        "ldapBindPassword":{
            "type":"string"
        },
        "userNameAttribute":{
            "type":"string"
        },
        "userClassName":{
            "type":"string"
        },
        "groupNameAttribute":{
            "type":"string"
        },
        "groupMembershipAttribute":{
            "type":"string"
        },
        "groupClassName":{
            "type":"string"
        },
        "connectTimeout":{
            "type":"integer"
        },
        "tlsRootCACertFileName":{
            "type":"string"
        },
        "bpmUserGroup":{
            "type":"string",
            "description":"Users with membership to this group can login and have full access Blockchain Platform Manager (this console) and perform life cycle operations on the Blockchain Platform instances. Required only for AD."
        },
        "caAdminGroup":{
            "type":"string",
            "description":"Users part of this group will have the authority to register other users. CA Administrator privilege is also needed to create a new Blockchain Platform instance. Required only for AD."
        },
        "instanceUserGroup":{
            "type":"string",
            "description":"Users with membership to this group can view the instances console using the UI or REST APIs. They will not be able to perform any other operations. Required only for AD."
        },
        "instanceAdminGroup":{
            "type":"string",
            "description":"Users with membership to this group can have full access to the instance console and perform all the operations on it using the UI or REST APIs. Required only for AD."
        },
        "restProxyGroup":{
            "type":"string",
            "description":"Users with membership to this group can interact with the instance using REST APIs. Required only for AD."
        },
        "backupHosts":{
            "type":"array",
            "description":"List of backup domain controllers for AD.",
            "items":{
                "type":"string"
            }
        }
    }
}

ネストしたスキーマ: backupHosts

型: array

ADのバックアップ・ドメイン・コントローラのリスト。

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"List of backup domain controllers for AD.",
    "items":{
        "type":"string"
    }
}

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json

200レスポンス

OK

400レスポンス

不正なリクエスト

401レスポンス

未認可

404レスポンス

無効なパラメータ

409レスポンス

操作の競合

本文()

ルート・スキーマ: Error

型: object

エラー情報。

ソースの表示

• errors: array errors
  エラーのリスト
• message(必須): string
  判読可能なエラー文字列。
• status(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・ステータス。
• warnings: array warnings
  警告のリスト

{
    "description":"Error information.",
    "required":[
        "status",
        "message"
    ],
    "properties":{
        "status":{
            "description":"A short error status that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        },
        "errors":{
            "type":"array",
            "description":"List of errors",
            "items":{
                "type":"string"
            }
        },
        "warnings":{
            "type":"array",
            "description":"List of warnings",
            "items":{
                "type":"string"
            }
        }
    }
}

ネストしたスキーマ: errors

型: array

エラーのリスト

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"List of errors",
    "items":{
        "type":"string"
    }
}

ネストしたスキーマ: warnings

型: array

警告のリスト

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"List of warnings",
    "items":{
        "type":"string"
    }
}

先頭に戻る

例

このエンドポイントは、Blockchain Platform内の指定されたLDAP構成をテストするために使用されます。

次の例は、cURLを使用してRESTリソースに対するPOSTリクエストを発行し、LDAP構成をテストする方法を示しています。

curl -X POST \
  http://<hostname>:<port>/api/v1/configuration/ldapConfig/test \
  -H 'Content-Type: application/json' \
  -d '<Request Body>'

リクエスト本文の例

JSON形式のリクエスト本文のコンテンツの例を次に示します。

{
  "ldapId": "a455c6ab-dc36-4553-90c4-bbbb3532bc50",
  "ldapName": "localLDAP",
  "ldapType": "openLDAP",
  "ldapHost": "10.0.2.15",
  "ldapPort": 389,
  "ldapTLSEnabled": false,
  "ldapBaseDN": "dc=example,dc=org",
  "ldapBindDN": "cn=admin,dc=example,dc=org",
  "ldapBindPassword": "awdrTHUK1!",
  "userNameAttribute": "cn",
  "userClassName": "simpleSecurityObject",
  "groupNameAttribute": "cn",
  "groupMembershipAttribute": "member",
  "groupClassName": "groupOfNames",
  "connectTimeout": 30000
}

レスポンス本文の例

JSON形式のレスポンス本文のコンテンツの例を次に示します。

{
    "status": "200",
    "message": "LDAP Server Connectivity test was successful"
}

先頭に戻る