Jump to

• Request
• Response

Test the Given LDAP Configuration

post

/api/v1/configuration/ldapConfig/test

Test the given LDAP configuration

Request

Supported Media Types

• application/json

Header Parameters

• Authorization(required): string
  Bearer access token. Supply as: Bearer .

Body ()

Default LDAP configuration payload.

Root Schema : schema

Type: object

Default LDAP configuration payload.

Show Source

• backupHosts: array backupHosts
  Maximum Number of Items: 2
• bpmUserGroup: string
• caAdminGroup: string
• connectTimeout: integer
• groupClassName(required): string
• groupMembershipAttribute(required): string
• groupNameAttribute(required): string
• instanceAdminGroup: string
• instanceUserGroup: string
• ldapBaseDN(required): string
• ldapBindDN(required): string
• ldapBindPassword(required): string(password)
• ldapHost(required): string
• ldapId: string
• ldapName(required): string
• ldapPort(required): integer
  Minimum Value: 1

  Maximum Value: 65535
• ldapTLSEnabled(required): boolean
  Must be true for the default OpenLDAP server.
• ldapType(required): string
• restProxyGroup: string
• userClassName(required): string
• userNameAttribute(required): string

{
    "type":"object",
    "description":"Default LDAP configuration payload.",
    "required":[
        "ldapName",
        "ldapType",
        "ldapHost",
        "ldapPort",
        "ldapTLSEnabled",
        "ldapBaseDN",
        "ldapBindDN",
        "ldapBindPassword",
        "userNameAttribute",
        "userClassName",
        "groupNameAttribute",
        "groupMembershipAttribute",
        "groupClassName"
    ],
    "properties":{
        "ldapId":{
            "type":"string"
        },
        "ldapName":{
            "type":"string"
        },
        "ldapType":{
            "type":"string"
        },
        "ldapHost":{
            "type":"string"
        },
        "ldapPort":{
            "type":"integer",
            "minimum":1,
            "maximum":65535
        },
        "ldapTLSEnabled":{
            "type":"boolean",
            "description":"Must be true for the default OpenLDAP server."
        },
        "ldapBaseDN":{
            "type":"string"
        },
        "ldapBindDN":{
            "type":"string"
        },
        "ldapBindPassword":{
            "type":"string",
            "format":"password"
        },
        "userNameAttribute":{
            "type":"string"
        },
        "userClassName":{
            "type":"string"
        },
        "groupNameAttribute":{
            "type":"string"
        },
        "groupMembershipAttribute":{
            "type":"string"
        },
        "groupClassName":{
            "type":"string"
        },
        "connectTimeout":{
            "type":"integer"
        },
        "bpmUserGroup":{
            "type":"string"
        },
        "caAdminGroup":{
            "type":"string"
        },
        "instanceUserGroup":{
            "type":"string"
        },
        "instanceAdminGroup":{
            "type":"string"
        },
        "restProxyGroup":{
            "type":"string"
        },
        "backupHosts":{
            "type":"array",
            "maxItems":2,
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : backupHosts

Type: array

Maximum Number of Items: 2

Show Source

• Array of: string

{
    "type":"array",
    "maxItems":2,
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

400 Response

Bad Request

Body ()

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

401 Response

Unauthorized

Body ()

Root Schema : AuthError

Type: object

Authentication or authorization error returned by request filters.

Show Source

• code(required): string
  Allowed Values: [ "UNAUTHENTICATED", "FORBIDDEN", "NOT_FOUND" ]
• message(required): string

{
    "description":"Authentication or authorization error returned by request filters.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "enum":[
                "UNAUTHENTICATED",
                "FORBIDDEN",
                "NOT_FOUND"
            ]
        },
        "message":{
            "type":"string"
        }
    }
}

403 Response

Forbidden. The authenticated caller lacks a required global role, instance-access-group membership, or a valid CSRF token.

Body ()

Root Schema : AuthError

Type: object

Authentication or authorization error returned by request filters.

Show Source

• code(required): string
  Allowed Values: [ "UNAUTHENTICATED", "FORBIDDEN", "NOT_FOUND" ]
• message(required): string

{
    "description":"Authentication or authorization error returned by request filters.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "enum":[
                "UNAUTHENTICATED",
                "FORBIDDEN",
                "NOT_FOUND"
            ]
        },
        "message":{
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Body ()

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

Back to Top