Skip to main content

Update LDAP Identity Provider​

Update LDAP Identity Provider

Path Parameters
    id string required
Request 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 link an existing ZITADEL user with an external account.

    isCreationAllowed boolean

    Enable if users should be able to create a new account in ZITADEL when using an external account.

    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.

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
PUT /idps/ldap/:id

Authorization

name: OAuth2type: oauth2scopes: openid,urn:zitadel:iam:org:project:id:zitadel:audflows: {
  "authorizationCode": {
    "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize",
    "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token",
    "scopes": {
      "openid": "openid",
      "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud"
    }
  }
}

Request

Base URL
https://$CUSTOM-DOMAIN/admin/v1
Bearer Token
id — path required
Content-Type
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"

  }

}
Accept
curl / cURL
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>' \
--data-raw '{
  "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"
  }
}'