Update Ldap Identity Source

Update an LDAP identity source

Replaces the configuration of the LDAP identity source identified by identity-source-id. As with creation, Installer validates connectivity to the LDAP server before saving; if the probe fails, the request is rejected with 400 and the existing configuration is left unchanged - fix the connection details and retry.

Request

URI

PUT

https://{api_host}/https://{api_host}:{port}/lh-appliance/iam/ldap-identity-sources/{identity-source-id}

COPY

Path Parameters

string

identity-source-id

Required

The id of the LDAP identity source to update, as returned by GET /iam/ldap-identity-sources.

Request Body

The updated LDAP identity source configuration.

LdapIdentitySource of type(s) application/json

Required

This request body class requires all of the following: ManagedResource , InlineLdapIdentitySource1

{
    "domain_name": "corp.example.com",
    "base_distinguished_name": "dc=corp,dc=example,dc=com",
    "ldap_type": "ACTIVE_DIRECTORY",
    "ldap_server": {
        "url": "ldaps://ldap.corp.example.com:636",
        "bind_identity": "[email protected]",
        "password": "********",
        "enabled": true
    }
}

Authentication

This operation uses the following authentication methods.

enterprise_admin

Responses

200

The LDAP identity source was updated and its connectivity was verified.

Returns LdapIdentitySource of type(s) application/json

This response body class contains all of the following: ManagedResource , InlineLdapIdentitySource1

{
    "_create_user": "string",
    "_create_time": 0,
    "_last_modified_user": "string",
    "_last_modified_time": 0,
    "_revision": 0,
    "_resource_type": "string",
    "_system_owned": false,
    "id": "string",
    "display_name": "string",
    "description": "string",
    "site_ids": [
        "string"
    ],
    "domain_name": "string",
    "alternative_domain_names": [
        "string"
    ],
    "ldap_type": "string",
    "base_distinguished_name": "string",
    "ldap_server": {
        "url": "string",
        "certificates": [
            "string"
        ],
        "bind_identity": "string",
        "password": "string",
        "enabled": false
    },
    "connectivity_result": {
        "result": "string",
        "errors": [
            {
                "error_type": "string",
                "message": "string"
            }
        ]
    }
}

400

The request body is missing a required field, contains an invalid value, or Installer could not connect to the LDAP server with the given configuration.

Returns Error of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

401

Unauthorized

Returns Unauthorized of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

403

Forbidden

Returns Forbidden of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

412

Precondition Failed

Returns PreconditionFailed of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

428

Precondition Required

Returns PreconditionRequired of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

429

Too Many Requests

Returns TooManyRequests of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

default

4XX and 5XX type errors with appropriate message

Returns Error of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

Code Samples

COPY

                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"domain_name":"string","base_distinguished_name":"string","ldap_server":"object","ldap_type":"string"}' https://{api_host}/https://{api_host}:{port}/lh-appliance/iam/ldap-identity-sources/{identity-source-id}

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

User Management Operations

POST

Logout