Jump to

• Request
• Response
• Examples

Create LDAP Configuration

post

/api/v1/configuration/ldapConfig

Creates a new LDAP configuration.

Request

Supported Media Types

• multipart/form-data

Form Parameters

• ldapTLSRootCACerte: string
• payload:
• setActiveLdapConfig(optional): boolean
  Default Value: false

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

400 Response

Bad Request

401 Response

Not authorized

409 Response

Operation conflict

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• errors(optional): array errors
  list of errors
• message: string
  A human-readable error string.
• status: string
  A short error status that defines the error, meant for programmatic parsing.
• warnings(optional): 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

Back to Top

Examples

This endpoint is used to create a new LDAP configuration in your Blockchain platform.

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

curl -X POST \
  http://<hostname>:<port>/api/v1/configuration/ldapConfig \
  -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:

{
"ldapName": "testLDAP",
"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": "LDAP Configuration added successfully"
}

Back to Top