Skip to main content
API Explorer|API Explorer
Settings/AD/LDAP/OAuth Operations
POSTAD/LDAP/OAuth OperationsSince 0.6SynchronousAuth Required

AddLdapServer

AddLdapServer

Execution Availability

Try It Out

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

Request Inputs

Body Fields

  • paramsObjectRequired

    Request body parameter object.

    • nameStringRequired

      The resource name.

    • descriptionStringRequired

      The detailed description of the resource.

    • urlStringRequired

      The URL of the LDAP server.

    • baseStringRequired

      The base DN of the LDAP server.

    • usernameStringRequired

      The username used to access the LDAP server.

    • passwordStringRequired

      The password.

    • encryptionStringRequired

      The encryption method.

  • systemTagsList

    Optional. The system tags.

  • userTagsList

    Optional. The user tags.

Responses

200 OK

On success, this API returns the following response structure.

  • errorErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error.

    • codeStringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • descriptionStringRequired

      The brief description of the error.

    • detailsStringRequired

      The details about the error.

    • elaborationStringRequired

      The reserved field. Default value: null.

    • opaqueLinkedHashMapRequired

      The reserved field. Default value: null.

    • causeErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • inventoryLdapServerInventoryRequired

    See inventory.

    • uuidStringRequired

      The resource UUID.

    • nameStringRequired

      The resource name.

    • descriptionStringRequired

      The detailed description of the resource.

    • urlStringRequired

      地址。

    • baseStringRequired

      The base DN of the LDAP server.

    • usernameStringRequired

      The username used to access the LDAP server.

    • passwordStringRequired

      The password.

    • encryptionStringRequired

      The encryption method.

    • createDateTimestampRequired

      The creation date.

    • lastOpDateTimestampRequired

      The last operation date.

Endpoint

POST/zstack/v1/ldap/servers

/zstack/v1/ldap/servers

Operation ID

AddLdapServer

Permalink

Request Example

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

Response Example

200
{ "inventory": { "uuid": "ef7291bd94ce478880938851e3ff6ad6", "name": "miao", "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