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

Query LDAP Server

Query LDAP Server

Execution Availability

Try It Out

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

Request Inputs

This API requires no request parameters.

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.

  • inventoriesListRequired

    For details, see inventories

    • uuidLongRequired

      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

GET/zstack/v1/ldap/servers

/zstack/v1/ldap/servers

Operation ID

QueryLdapServer

Permalink

Request Example

curl -X GET 'http://{host}/zstack/v1/ldap/servers' -H 'Authorization: OAuth {sessionUuid}'

Response Example

200
{ "inventories": [ { "uuid": "fea82960cbaa33bb9f3de91c8054af8d", "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