Jump to

• Request
• Response
• Examples

Test LDAP Configuration

post

/api/v1/configuration/ldapConfig/test

Tests the specified LDAP configuration.

Request

Supported Media Types

• application/json

Body ()

LDAP Configuration details

Root Schema : LdapConfigDetail

Type: object

LDAP Configuration details

Show Source

• connectTimeout(optional): integer
• groupClassName(optional): string
• groupMembershipAttribute(optional): string
• groupNameAttribute(optional): string
• ldapBaseDN(optional): string
• ldapBindDN(optional): string
• ldapBindPassword(optional): string
• ldapHost(optional): string
• ldapId(optional): string
• ldapName(optional): string
• ldapPort(optional): integer
• ldapTLSCACert(optional): string
• ldapTLSEnabled(optional): boolean
• ldapType(optional): string
• tlsRootCACertFileName(optional): string
• userClassName(optional): string
• userNameAttribute(optional): 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"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

400 Response

Bad Request

401 Response

Not authorized

404 Response

Invalid parameters

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

Back to Top

Examples

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

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

curl -X POST \
  http://<hostname>:<port>/api/v1/configuration/ldapConfig/test \
  -H 'Content-Type: application/json' \
  -d '<Request Body>'

Example of the Request Body

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

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

Example of the Response Body

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

{
    "status": "200",
    "message": "LDAP Server Connectivity test was successful"
}

Back to Top