ZStack Cloud Documentation
All
All
ZStack 3.10.0>API Reference>Enterprise Management (Plus)>3rd Party Authentication Operations
Get PDF

CreateIAM2VirtualIDFromLdapUid

API Request

URLs
POST zstack/v1/iam2/virtual-id/ldap/uid
Headers
Authorization: OAuth the-session-uuid
Curl Sample
curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X POST http://localhost:8080/zstack/v1/iam2/virtual-id/ldap/uid
Request Parameters
Name Type Location Description Optional Value Starting Version
ldapUid String body The AD/LDAP user UUID. 3.5.1
resourceUuid String body Optional. The resource UUID. 3.5.1
tagUuids List body Optional. The tag UUID list. 3.5.1
systemTags List body Optional. 3.5.1
userTags List body Optional. 3.5.1

API Response

Sample Response
{   "inventory": {     "uuid": "417c94a9fdfb3b61b2e0d11ed42f4b4d",     "ldapUid": "ou\u003dEmployee,uid\u003dtest",     "ldapServerUuid": "6e667cc905903cfc82ddef6f14d45831",     "virtualIDUuid": "bbcf2b14a0d13401872088bd1aa7f930"   } }
Name Type Description Starting Version
error ErrorCode The error code. If not null, the operation fails, or vice versa. For more information, see error. 3.5.1
inventory LdapIAM2VirtualIDRefInventory See inventory. 3.5.1
#error
Name Type Description Starting Version
code String The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. 3.5.1
description String The brief description of the error. 3.5.1
details String The details about the error. 3.5.1
elaboration String The reserved field. Default value: null. 3.5.1
opaque LinkedHashMap The reserved field. Default value: null. 3.5.1
cause ErrorCode The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. 3.5.1
#inventory
Name Type Description Starting Version
uuid String The resource UUID. 3.5.1
ldapUid String The AD/LDAP entry UID. 3.5.1
ldapServerUuid String The AD/LDAP server UUID. 3.5.1
resourceUuid String The UUID of the associated resource. 3.5.1
createDate Timestamp The creation date. 3.5.1
lastOpDate Timestamp The last operation date. 3.5.1

SDK Sample

Java SDK
CreateIAM2VirtualIDFromLdapUidAction action = new CreateIAM2VirtualIDFromLdapUidAction(); action.ldapUid = "ou=Employee,uid=test"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; CreateIAM2VirtualIDFromLdapUidAction.Result res = action.call();
Python SDK
CreateIAM2VirtualIDFromLdapUidAction action = CreateIAM2VirtualIDFromLdapUidAction() action.ldapUid = "ou=Employee,uid=test" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" CreateIAM2VirtualIDFromLdapUidAction.Result res = action.call()

CreateIAM2VirtualIDLdapBinding

API Request

URLs
POST zstack/v1/iam2/ldap/bindings
Headers
Authorization: OAuth the-session-uuid
Curl Sample
curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X POST http://localhost:8080/zstack/v1/iam2/ldap/bindings
Request Parameters
Name Type Location Description Optional Value Starting Version
virtualIDUuid String body The user UUID. 3.5.1
ldapUid String body The AD/LDAP user UUID. 3.5.1
resourceUuid String body Optional. 3.5.1
tagUuids List body Optional. The tag UUID list. 3.5.1
systemTags List body Optional. 3.5.1
userTags List body Optional. 3.5.1

API Response

Sample Response
{   "inventory": {     "uuid": "35f1a7c85cf038f6892a9c6b5e2f0470",     "ldapUid": "ou\u003dEmployee,uid\u003dtest",     "ldapServerUuid": "1bca8f5b607b3d0d9cc5b22270c3a262",     "virtualIDUuid": "5d1be61d0d1d3657afdd9e7829f4d2ed"   } }
Name Type Description Starting Version
error ErrorCode The error code. If not null, the operation fails, or vice versa. For more information, see error. 3.5.1
inventory LdapIAM2VirtualIDRefInventory See inventory. 3.5.1
#error
Name Type Description Starting Version
code String The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. 3.5.1
description String The brief description of the error. 3.5.1
details String The details about the error. 3.5.1
elaboration String The reserved field. Default value: null. 3.5.1
opaque LinkedHashMap The reserved field. Default value: null. 3.5.1
cause ErrorCode The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. 3.5.1
#inventory
Name Type Description Starting Version
uuid String The resource UUID. 3.5.1
ldapUid String The AD/LDAP entry UID. 3.5.1
ldapServerUuid String The AD/LDAP server UUID. 3.5.1
resourceUuid String The UUID of the associated resource. 3.5.1
createDate Timestamp The creation date. 3.5.1
lastOpDate Timestamp The last operation date. 3.5.1

SDK Sample

Java SDK
CreateIAM2VirtualIDLdapBindingAction action = new CreateIAM2VirtualIDLdapBindingAction(); action.virtualIDUuid = "52d9727518053f50889bebe14617d2d2"; action.ldapUid = "ou=Employee,uid=test"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; CreateIAM2VirtualIDLdapBindingAction.Result res = action.call();
Python SDK
CreateIAM2VirtualIDLdapBindingAction action = CreateIAM2VirtualIDLdapBindingAction() action.virtualIDUuid = "52d9727518053f50889bebe14617d2d2" action.ldapUid = "ou=Employee,uid=test" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" CreateIAM2VirtualIDLdapBindingAction.Result res = action.call()

GetCandidateLdapEntryForIAM2Binding

API Request

URLs
GET zstack/v1/iam2/ldap/entries/candidates
Headers
Authorization: OAuth the-session-uuid
Curl Sample
curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X GET http://localhost:8080/zstack/v1/iam2/ldap/entries/candidates?ldapFilter=(cn=user_xxx)&limit=2500.0
Request Parameters
Name Type Location Description Optional Value Starting Version
ldapFilter String query The AD/LDAP query filter. 3.5.1
limit Integer query Optional. The limit of AD/LDAP query entries. 3.5.1
systemTags List query Optional. 3.5.1
userTags List query Optional. 3.5.1

API Response

Sample Response
{   "inventories": [] }
Name Type Description Starting Version
inventories List 3.5.1
error ErrorCode The error code. If not null, the operation fails, or vice versa. For more information, see error. 3.5.1
#error
Name Type Description Starting Version
code String The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. 3.5.1
description String The brief description of the error. 3.5.1
details String The details about the error. 3.5.1
elaboration String The reserved field. Default value: null. 3.5.1
opaque LinkedHashMap The reserved field. Default value: null. 3.5.1
cause ErrorCode The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. 3.5.1

SDK Sample

Java SDK
GetCandidateLdapEntryForIAM2BindingAction action = new GetCandidateLdapEntryForIAM2BindingAction(); action.ldapFilter = "(cn=user_xxx)"; action.limit = 2500.0; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; GetCandidateLdapEntryForIAM2BindingAction.Result res = action.call();
Python SDK
GetCandidateLdapEntryForIAM2BindingAction action = GetCandidateLdapEntryForIAM2BindingAction() action.ldapFilter = "(cn=user_xxx)" action.limit = 2500.0 action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" GetCandidateLdapEntryForIAM2BindingAction.Result res = action.call()





Products

Solutions

Help & Support

Contact Us

© 2023, Shanghai Yunzhou Information and Technology Ltd (云轴科技). All Rights Reserved.

Back to Top

Download

Already filled the basic info?Click here.

Enter at least 2 characters.
Invalid mobile number.
Enter at least 4 characters.
Invalid email address.
Wrong code. Try again. Send Code Resend Code (60s)

An email with a verification code will be sent to you. Make sure the address you provided is valid and correct.

Download

Not filled the basic info yet? Click here.

Invalid email address or mobile number.

Email Us

contact@zstack.io
ZStack Training and Certification
Enter at least 2 characters.
Invalid mobile number.
Enter at least 4 characters.
Invalid email address.
Wrong code. Try again. Send Code Resend Code (60s)

Email Us

contact@zstack.io
Request Trial
Enter at least 2 characters.
Invalid mobile number.
Enter at least 4 characters.
Invalid email address.
Wrong code. Try again. Send Code Resend Code (60s)

Email Us

contact@zstack.io

The download link is sent to your email address.

If you don't see it, check your spam folder, subscription folder, or AD folder. After receiving the email, click the URL to download the documentation.

The download link is sent to your email address.

If you don't see it, check your spam folder, subscription folder, or AD folder.
Or click on the URL below. (For Internet Explorer, right-click the URL and save it.)

Thank you for using ZStack products and services.

Submit successfully.

We'll connect soon.

Thank you for using ZStack products and services.