Jump to

• Request
• Response
• Examples

Get LDAP Configuration

get

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

Gets the LDAP configuration.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  Unique LDAP configuration identifier

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : LdapConfigDetail

Type: object

LDAP Configuration details

Show Source

• backupHosts(optional): array backupHosts
  List of backup domain controllers for AD.
• bpmUserGroup(optional): 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(optional): 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(optional): integer
• groupClassName(optional): string
• groupMembershipAttribute(optional): string
• groupNameAttribute(optional): string
• instanceAdminGroup(optional): 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(optional): 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(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
• restProxyGroup(optional): string
  Users with membership to this group can interact with the instance using REST APIs. Required only for AD.
• 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"
        },
        "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"
    }
}

400 Response

Bad Request

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

401 Response

Unauthorized

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

404 Response

Not Found

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 get the details of a specific LDAP configuration in your Blockchain platform.

The following example shows how to generate the LDAP configuration report by submitting a GET request on the REST resource using cURL.

curl -X GET \
  http://<hostname>:<port>/api/v1/configuration/ldapConfig/<unique LDAP config identifier>

For example,

curl -X GET \
  http://localhost:17070/api/v1/configuration/ldapConfig/a455c6ab-dc36-4553-90c4-bbbb3532bc50

Example of the Response Body

The following example shows the contents of the response 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": "********",
    "userNameAttribute": "cn",
    "userClassName": "simpleSecurityObject",
    "groupNameAttribute": "cn",
    "groupMembershipAttribute": "member",
    "groupClassName": "groupOfNames",
    "connectTimeout": 30000
}

Back to Top