移動

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

LDAP構成の取得

get

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

LDAP構成を取得します。

リクエスト

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

• application/json

パス・パラメータ

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

先頭に戻る

レスポンス

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

• application/json

200レスポンス

OK

本文()

ルート・スキーマ: LdapConfigDetail

型: object

LDAP構成の詳細

ソースの表示

• connectTimeout(オプション): integer
• groupClassName(オプション): string
• groupMembershipAttribute(オプション): string
• groupNameAttribute(オプション): string
• ldapBaseDN(オプション): string
• ldapBindDN(オプション): string
• ldapBindPassword(オプション): string
• ldapHost(オプション): string
• ldapId(オプション): string
• ldapName(オプション): string
• ldapPort(オプション): integer
• ldapTLSCACert(オプション): string
• ldapTLSEnabled(オプション): boolean
• ldapType(オプション): string
• 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"
        }
    }
}

400レスポンス

不正なリクエスト

401レスポンス

未認可

404レスポンス

無効なパラメータ

先頭に戻る

例

このエンドポイントは、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
}

先頭に戻る