Skip to main content

Add LDAP Identity Provider​

Add LDAP Identity Provider

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.

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
  • id string
POST /idps/ldap

Authorization

type: oauth2flow: authorizationCodescopes: openid,urn:zitadel:iam:org:project:id:zitadel:aud

Request

Base URL
https://$ZITADEL_DOMAIN/admin/v1
Bearer Token
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

  }

}
Accept
curl -L -X POST 'https://$ZITADEL_DOMAIN/admin/v1/idps/ldap' \
-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
  }
}'