移動

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

LDAP構成の取得

get

/api/v1/configuration/ldapConfig/{id}

LDAP構成を取得します。

リクエスト

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

• application/json

パス・パラメータ

• id: string
  一意のLDAP構成の識別子

先頭に戻る

レスポンス

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

• application/json

200レスポンス

OK

本文()

ルート・スキーマ: 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"
    }
}

400レスポンス

不正なリクエスト

本文()

ルート・スキーマ: 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"
    }
}

401レスポンス

未認可

本文()

ルート・スキーマ: 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"
    }
}

404レスポンス

見つかりません

本文()

ルート・スキーマ: 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リソースに対するGETリクエストを発行し、LDAP構成レポートを生成する方法を示しています。

curl -X GET \
  http://<hostname>:<port>/api/v1/configuration/ldapConfig/<unique LDAP config identifier>

例:

curl -X GET \
  http://localhost:17070/api/v1/configuration/ldapConfig/a455c6ab-dc36-4553-90c4-bbbb3532bc50

レスポンス本文の例

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": "********",
    "userNameAttribute": "cn",
    "userClassName": "simpleSecurityObject",
    "groupNameAttribute": "cn",
    "groupMembershipAttribute": "member",
    "groupClassName": "groupOfNames",
    "connectTimeout": 30000
}

先頭に戻る