移動

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

LDAP構成の更新

post

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

LDAP構成を更新します。

リクエスト

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

• multipart/form-data

パス・パラメータ

• id(必須): string
  一意のLDAP構成の識別子

問合せパラメータ

• isActive: boolean
  デフォルト値: false
• removeTLSRootCACert: boolean
  デフォルト値: false

フォーム・パラメータ

• ldapTLSRootCACert: string
  .crtファイル内のLDAPサーバーのルート認証局(CA)証明書
• payload:

先頭に戻る

レスポンス

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

• application/json

200レスポンス

OK

400レスポンス

不正なリクエスト

401レスポンス

未認可

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"
    }
}

500レスポンス

サービス使用不可

先頭に戻る

例

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

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

curl -X POST \
  http://<hostname>:<port>/api/v1/configuration/ldapConfig/<unique LDAP configuration ID> \
  -H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
  -F 'payload=<Request Body>'

リクエスト本文の例

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

{
    "ldapId": "212880b2-4b81-4cc3-9c41-9bd34cd29e25",
    "ldapName": "testLDAPchanged",
    "ldapType": "OpenLDAP",
    "ldapHost": "<host IP address>",
    "ldapPort": 389,
    "ldapTLSEnabled": false,
    "ldapBaseDN": "dc=example,dc=org",
    "ldapBindDN": "cn=admin,dc=example,dc=org",
    "ldapBindPassword": "<bind password>",
    "userNameAttribute": "cn",
    "userClassName": "person",
    "groupNameAttribute": "cn",
    "groupMembershipAttribute": "member",
    "groupClassName": "groupOfNames",
    "connectTimeout": 20000
  }

レスポンス本文の例

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

{
    "status": "200",
    "message": "Successfully updated LDAP Configuration [testLDAPchanged]"
}

先頭に戻る