Skip to main content

Update LDAP Identity Provider

PUT 
https://$CUSTOM-DOMAIN/admin/v1/idps/ldap/:id

Update LDAP Identity Provider

Request​

Path Parameters

    id stringrequired

Body

required

    name string
    servers string[]
    startTls boolean
    baseDn string
    bindDn string
    bindPassword string
    userBase string
    userObjectClasses string[]
    userFilters string[]
    timeout string

    attributes

    object

    idAttribute string
    firstNameAttribute string
    lastNameAttribute string
    displayNameAttribute string
    nickNameAttribute string
    preferredUsernameAttribute string
    emailAttribute string
    emailVerifiedAttribute string
    phoneAttribute string
    phoneVerifiedAttribute string
    preferredLanguageAttribute string
    avatarUrlAttribute string
    profileAttribute string

    providerOptions

    object

    isLinkingAllowed boolean

    Enable if users should be able to manually link an existing ZITADEL user with an external account. Disable if users should only be allowed to link the proposed account in case of active auto_linking.

    isCreationAllowed boolean

    Enable if users should be able to manually create a new account in ZITADEL when using an external account. Disable if users should not be able to edit account information when auto_creation is enabled.

    isAutoCreation boolean

    Enable if a new account in ZITADEL should be created automatically when login with an external account.

    isAutoUpdate boolean

    Enable if a the ZITADEL account fields should be updated automatically on each login.

    autoLinking string

    Possible values: [AUTO_LINKING_OPTION_UNSPECIFIED, AUTO_LINKING_OPTION_USERNAME, AUTO_LINKING_OPTION_EMAIL]

    Default value: AUTO_LINKING_OPTION_UNSPECIFIED

    Enable if users should get prompted to link an existing ZITADEL user to an external account if the selected attribute matches.

    rootCa byte

    Root_ca is for self signing certificates for TLS connections to LDAP servers it is intended to be filled with a .pem file.

Responses​

A successful response.

Schema

    details

    object

    sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    creationDate date-time

    on read: the timestamp of the first event of the object

    on create: the timestamp of the event(s) added by the manipulation

    changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the

    resourceOwner resource_owner is the organization an object belongs to (string)
curl -L -X PUT 'https://$CUSTOM-DOMAIN/admin/v1/idps/ldap/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "name": "string",
  "servers": [
    "string"
  ],
  "startTls": true,
  "baseDn": "string",
  "bindDn": "string",
  "bindPassword": "string",
  "userBase": "string",
  "userObjectClasses": [
    "string"
  ],
  "userFilters": [
    "string"
  ],
  "timeout": "string",
  "attributes": {
    "idAttribute": "string",
    "firstNameAttribute": "string",
    "lastNameAttribute": "string",
    "displayNameAttribute": "string",
    "nickNameAttribute": "string",
    "preferredUsernameAttribute": "string",
    "emailAttribute": "string",
    "emailVerifiedAttribute": "string",
    "phoneAttribute": "string",
    "phoneVerifiedAttribute": "string",
    "preferredLanguageAttribute": "string",
    "avatarUrlAttribute": "string",
    "profileAttribute": "string"
  },
  "providerOptions": {
    "isLinkingAllowed": true,
    "isCreationAllowed": true,
    "isAutoCreation": true,
    "isAutoUpdate": true,
    "autoLinking": "AUTO_LINKING_OPTION_UNSPECIFIED"
  },
  "rootCa": "string"
}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN/admin/v1
Auth
Parameters
— pathrequired
Body required
{
  "name": "string",
  "servers": [
    "string"
  ],
  "startTls": true,
  "baseDn": "string",
  "bindDn": "string",
  "bindPassword": "string",
  "userBase": "string",
  "userObjectClasses": [
    "string"
  ],
  "userFilters": [
    "string"
  ],
  "timeout": "string",
  "attributes": {
    "idAttribute": "string",
    "firstNameAttribute": "string",
    "lastNameAttribute": "string",
    "displayNameAttribute": "string",
    "nickNameAttribute": "string",
    "preferredUsernameAttribute": "string",
    "emailAttribute": "string",
    "emailVerifiedAttribute": "string",
    "phoneAttribute": "string",
    "phoneVerifiedAttribute": "string",
    "preferredLanguageAttribute": "string",
    "avatarUrlAttribute": "string",
    "profileAttribute": "string"
  },
  "providerOptions": {
    "isLinkingAllowed": true,
    "isCreationAllowed": true,
    "isAutoCreation": true,
    "isAutoUpdate": true,
    "autoLinking": "AUTO_LINKING_OPTION_UNSPECIFIED"
  },
  "rootCa": "string"
}
ResponseClear

Click the Send API Request button above and see the response here!