REST API for Oracle Blockchain Platform Enterprise Edition

Test LDAP Configuration

post

/api/v1/configuration/ldapConfig/test

Tests the specified LDAP configuration.

Request

Supported Media Types

application/json

LDAP Configuration details

Root Schema : LdapConfigDetail

Type: object

LDAP Configuration details

Show Source

backupHosts: array backupHosts

List of backup domain controllers for AD.
bpmUserGroup: string

Users with membership to this group can login and have full access Blockchain Platform Manager (this console) and perform life cycle operations on the Blockchain Platform instances. Required only for AD.
caAdminGroup: string

Users part of this group will have the authority to register other users. CA Administrator privilege is also needed to create a new Blockchain Platform instance. Required only for AD.
connectTimeout: integer
groupClassName: string
groupMembershipAttribute: string
groupNameAttribute: string
instanceAdminGroup: string

Users with membership to this group can have full access to the instance console and perform all the operations on it using the UI or REST APIs. Required only for AD.
instanceUserGroup: string

Users with membership to this group can view the instances console using the UI or REST APIs. They will not be able to perform any other operations. Required only for AD.
ldapBaseDN: string
ldapBindDN: string
ldapBindPassword: string
ldapHost: string
ldapId: string
ldapName: string
ldapPort: integer
ldapTLSCACert: string
ldapTLSEnabled: boolean
ldapType: string
restProxyGroup: string

Users with membership to this group can interact with the instance using REST APIs. Required only for AD.
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"
        },
        "bpmUserGroup":{
            "type":"string",
            "description":"Users with membership to this group can login and have full access Blockchain Platform Manager (this console) and perform life cycle operations on the Blockchain Platform instances. Required only for AD."
        },
        "caAdminGroup":{
            "type":"string",
            "description":"Users part of this group will have the authority to register other users. CA Administrator privilege is also needed to create a new Blockchain Platform instance. Required only for AD."
        },
        "instanceUserGroup":{
            "type":"string",
            "description":"Users with membership to this group can view the instances console using the UI or REST APIs. They will not be able to perform any other operations. Required only for AD."
        },
        "instanceAdminGroup":{
            "type":"string",
            "description":"Users with membership to this group can have full access to the instance console and perform all the operations on it using the UI or REST APIs. Required only for AD."
        },
        "restProxyGroup":{
            "type":"string",
            "description":"Users with membership to this group can interact with the instance using REST APIs. Required only for AD."
        },
        "backupHosts":{
            "type":"array",
            "description":"List of backup domain controllers for AD.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : backupHosts

Type: array

List of backup domain controllers for AD.

Show Source

Array of: string

{
    "type":"array",
    "description":"List of backup domain controllers for AD.",
    "items":{
        "type":"string"
    }
}

Response

Supported Media Types

application/json

200 Response

400 Response

Bad request

401 Response

Not authorized

404 Response

Invalid parameters

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

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