Update an LDAP authentication profile of an event broker service

An LDAP authentication profile tells the event broker service how to reach an LDAP directory and how to search it: the LDAP servers to contact, the credentials to bind with, and the searches that resolve a user and their group membership.

Two profile names have a fixed meaning on the event broker service. The default profile authenticates clients and cannot be deleted. The management profile authenticates management users when an LDAP management access configuration exists, and cannot be deleted while one does. A profile with any other name is stored and applied to the event broker service, but nothing on the event broker service binds to it, so it has no effect until a future API binds it.

The API updates only the fields included in the request. The name of a profile cannot be changed. Each LDAP server is a separate field: including ldapServerOne, ldapServerTwo or ldapServerThree replaces the server in that position, and omitting one leaves that position unchanged. A position cannot be emptied once it is set.

Omitting adminPassword keeps the stored password. It cannot be cleared, because the profile cannot bind to the LDAP directory without one.

Your token must have one of the permissions listed in the Token Permissions.



Token Permissions: [ mission_control:access or services:put ]
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique identifier of the event broker service.

string
required

The name of the LDAP authentication profile.

Body Params

The LDAP authentication profile fields to change.

string

The name of the LDAP authentication profile. The name must be 1-32 characters using only letters, digits, and underscores. The name must be unique within the event broker service and cannot be changed after the profile is created.

boolean

Indicates whether the LDAP authentication profile is enabled. A value of 'true' indicates the profile is enabled and 'false' indicates it is disabled. A profile cannot be enabled without a search base distinguished name.

boolean

Indicates whether clients that provide an empty password are authenticated without an LDAP bind. A value of 'true' indicates unauthenticated authentication is allowed and 'false' indicates it is not. The default is 'false'.

boolean

Indicates whether the event broker service upgrades the LDAP connection to TLS using StartTLS. A value of 'true' indicates StartTLS is enabled and 'false' indicates it is not. The default is 'false'.

string

The distinguished name used by the event broker service to bind to the LDAP directory when searching for users.

string
length between 0 and 128

The password used by the event broker service to bind to the LDAP directory when searching for users. This field is never returned in a response. Omitting it from an update request keeps the stored password; a blank value is rejected, because a stored password cannot be cleared.

string

The URI of the first LDAP server the event broker service contacts. Required on create. Use the ldap:// or ldaps:// scheme. Omitting this field from an update request leaves the configured server unchanged.

string

The URI of the second LDAP server, contacted when the first does not respond. Use the ldap:// or ldaps:// scheme. Omitting this field from an update request leaves the configured server unchanged.

string

The URI of the third LDAP server, contacted when neither of the first two responds. Use the ldap:// or ldaps:// scheme. Omitting this field from an update request leaves the configured server unchanged.

string

The base distinguished name where the primary LDAP search for users begins.

string
enum

Specifies when the secondary group membership search dereferences LDAP aliases.

Allowed:
string

The LDAP filter used by the primary search to match entries.

boolean

Indicates whether the primary search follows continuation references returned by the LDAP server. A value of 'true' indicates continuation references are followed and 'false' indicates they are not. The default is 'true'.

string
enum

Specifies how far below the search base distinguished name the secondary group membership search descends.

Allowed:
int32

The number of seconds the primary search waits for the LDAP server to respond. The valid range is 1-40. The default is 5.

boolean

Indicates whether a secondary search resolves group membership after the primary search. A value of 'true' indicates the secondary search is enabled and 'false' indicates it is not. The default is 'false'.

string

The base distinguished name where the secondary group membership search begins.

string
enum

Specifies when the secondary group membership search dereferences LDAP aliases.

Allowed:
string

The LDAP filter used by the secondary group membership search to match entries.

string

The attribute from the primary search result to substitute into the secondary group membership search filter.

boolean

Indicates whether the secondary group membership search follows continuation references returned by the LDAP server. A value of 'true' indicates continuation references are followed and 'false' indicates they are not. The default is 'true'.

string
enum

Specifies how far below the search base distinguished name the secondary group membership search descends.

Allowed:
int32

The number of seconds the secondary group membership search waits for the LDAP server to respond. The valid range is 1-40. The default is 5.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*