Skip to main content
API Explorer|API Explorer
System Management/Single Sign-On Server Interfaces
PUTSingle Sign-On Server InterfacesSince 4.3.0SynchronousAuth Required

Update LDAP Server

Update LDAP Server

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • ldapServerUuidStringRequired

    UUID of the LDAP server

Body Fields

  • nameString

    Resource name

  • descriptionString

    Detailed description of the resource

  • urlString

    Access URL of the LDAP server

  • baseString

    Query BaseDN of the LDAP server

  • usernameString

    Username for accessing the LDAP server

Responses

200 OK

On success, this API returns the following response structure.

  • successbooleanRequired

    操作是否成功。

  • errorErrorCodeRequired

    Error code. If not null, the operation has failed. This field is null when the operation succeeds. For details, see error

    • codeStringRequired

      Error code number. The globally unique identifier of the error, for example, SYS.1000 or HOST.1001.

    • descriptionStringRequired

      Brief description of the error

    • detailsStringRequired

      Detailed information about the error

    • elaborationStringRequired

      Reserved field. Default is null.

    • opaqueLinkedHashMapRequired

      Reserved field. Default is null.

    • causeErrorCodeRequired

      Root error. The source error that caused the current error. This field is null if no root error exists.

  • inventoryLdapServerInventoryRequired

    For details, see inventory

    • uuidStringRequired

      Resource UUID. Uniquely identifies the resource.

    • nameStringRequired

      Resource name

    • typeStringRequired

      User source type, typically ldap

    • descriptionStringRequired

      Detailed description of the resource

    • urlStringRequired

      地址。

    • baseStringRequired

      LDAP server access URL

    • usernameStringRequired

      Username for accessing the LDAP server

    • passwordStringRequired

      Password

    • encryptionStringRequired

      Encryption method

    • serverTypeStringRequired

      Server type. Possible values are OpenLdap or WindowsAD. Returns Unknown if the type cannot be determined.

    • createDateTimestampRequired

      Creation time

    • lastOpDateTimestampRequired

      Last modification time

Endpoint

PUT/zstack/v1/ldap/servers/{ldapServerUuid}

/zstack/v1/ldap/servers/{ldapServerUuid}

Operation ID

UpdateLdapServer

Permalink

Request Example

curl -X PUT 'http://{host}/zstack/v1/ldap/servers/{ldapServerUuid}' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"name":"<name>","description":"<description>","url":"<url>","base":"<base>","username":"<username>","password":"<password>","encryption":"<encryption>","systemTags":["<systemTags>"],"userTags":["<userTags>"],"serverType":"<serverType>","usernameProperty":"<usernameProperty>","filter":"<filter>","syncCreatedAccountStrategy":"<syncCreatedAccountStrategy>","syncDeletedAccountStrategy":"<syncDeletedAccountStrategy>"}'

Response Example

200
{ "inventory": { "uuid": "5c502802c9633f4398e9f286d8187f49", "name": "new name", "description": "miao desc", "url": "ldap://localhost:1888", "base": "dc\u003dexample,dc\u003dcom", "username": "", "password": "", "encryption": "None" } }

Change History

This API has no change history records yet.

View all change history