REST API for Oracle Blockchain Platform Enterprise Edition

Update LDAP Configuration

post

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

Updates the LDAP configuration.

Request

Supported Media Types

multipart/form-data

Path Parameters

id(required): string

Unique LDAP configuration identifier

Query Parameters

isActive: boolean

Default Value: false
removeTLSRootCACert: boolean

Default Value: false

Form Parameters

ldapTLSRootCACert: string

The root certificate authority (CA) certificate for the LDAP server in a .crt file
payload:

Response

Supported Media Types

application/json

200 Response

400 Response

Bad request

401 Response

Not authorized

409 Response

Operation conflict

Root Schema : Error

Type: object

Error information.

Show Source

errors: array errors

List of errors
message(required): string

A human-readable error string.
status(required): string

A short error status that defines the error, meant for programmatic parsing.
warnings: array warnings

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

Nested Schema : errors

Type: array

List of errors

Show Source

Array of: string

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

Nested Schema : warnings

Type: array

List of warnings

Show Source

Array of: string

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

500 Response

Service unavailable

Examples

This endpoint is used to update the specified LDAP configuration in your Blockchain platform.

The following example shows how to update the name of a LDAP configuration by submitting a POST request on the REST resource using cURL.

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>'

Example of the Request Body

The following example shows the contents of the request body in JSON format:

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

Example of the Response Body

The following example shows the contents of the response body in JSON format:

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