DocsKnowledge BaseAPI Explorer
Documentation›ZCF›ZStack Cloud›Explore more›CLI Command ManualZCF
Document navigation

SSO

CreateIAM2VirtualIDFromLdapUid

Creates a user from an LDAP user. For example,
CreateIAM2VirtualIDFromLdapUid ldapUid=ou\u003dEmployee,uid\u003dtest

Parameters

Name Description Optional Valid Value Starting Version
ldapUid The AD/LDAP user UID. 3.5.1
resourceUuid The resource UUID. Yes 3.5.1
tagUuids The tag UUID list. Yes 3.5.1
userTags The user tags. For more information, see CreateUserTag. Yes 3.5.1
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.5.1
timeout Yes

CreateIAM2VirtualIDLdapBinding

Binds a user and an LDAP user. For example,
CreateIAM2VirtualIDLdapBinding virtualIDUuid=5d1be61d0d1d3657afdd9e7829f4d2ed ldapUid=ou\u003dEmployee,uid\u003dtest

Parameters

Name Description Optional Valid Value Starting Version
virtualIDUuid The user UUID. 3.5.1
ldapUid The AD/LDAP user UUID. 3.5.1
resourceUuid Yes 3.5.1
tagUuids The tag UUID list. Yes 3.5.1
userTags The user tags. For more information, see CreateUserTag. Yes 3.5.1
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.5.1
timeout Yes

GetCandidateLdapEntryForIAM2Binding

Obtains an LDAP entry for user binding. For example,
GetCandidateLdapEntryForIAM2Binding ldapFilter=(cn=mevoco)

Parameters

Name Description Optional Valid Value Starting Version
ldapFilter The AD/LDAP query filter. 3.5.1
limit The limit of AD/LDAP query entries. Yes 3.5.1
userTags The user tags. For more information, see CreateUserTag. Yes 3.5.1
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.5.1
timeout Yes

LoginIAM2VirtualIDWithLdap

Performs login as a user through LDAP authentication. For example, 
LoginIAM2VirtualIDWithLdap uid=test password=password

Parameters

Name Description Optional Valid Value Starting Version
uid The login attribute value of the AD/LDAP user. 3.5.1
password The login password of the AD/LDAP user. 3.5.1
verifyCode The login verification code. Yes 3.5.1
captchaUuid The UUID of the login authentication code. Yes 3.5.1
userTags The user tags. For more information, see CreateUserTag. Yes 3.5.1
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.5.1
timeout Yes

DeleteIAM2VirtualIDLdapBinding

Deletes the binding between a user and an LDAP user. For example,
DeleteIAM2VirtualIDLdapBinding uuid=0a7983d3082530c4b6d4b844e694694e

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 3.5.1
deleteMode Yes 3.5.1
userTags The user tags. For more information, see CreateUserTag. Yes 3.5.1
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.5.1
timeout Yes

CleanInvalidLdapIAM2Binding

Cleans the binding between a user and an LDAP user. For example,
CleanInvalidLdapIAM2Binding

Parameters

Name Description Optional Valid Value Starting Version
userTags The user tags. For more information, see CreateUserTag. Yes 3.5.1
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.5.1
timeout Yes

QueryIAM2LdapBinding

Queries the binding between a user and an LDAP user. For example,
QueryIAM2LdapBinding

Primitive Fields of Query

See IAM2 LDAP Binding Inventory.

SyncLdapServer

Synchronizes an AD/LDAP server and an AD/LDAP organization. For example,
SyncLdapServer uuid=14dc461677b23ea1a984849f501a7152

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 3.5.1
userTags The user tags. For more information, see CreateUserTag. Yes 3.5.1
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.5.1
timeout Yes

CreateOAuthClient

Create an OAuth client. For example, 
CreateOAuthClient name=test clientId=756770202fcd36bfbaa00ea7dea7f5ff tokenUrl=http://zstack.com/token loginType=oauth2-iam2 clientType=OAuth2 grantType=authorization_code

Parameters

Name Description Optional Valid Value Starting Version
name The resource name. 4.5.0
description The detailed information of the resource. Yes 4.5.0
clientId The client ID. 4.5.0
clientSecret The client key. Yes 4.5.0
authorizationUrl The authentication url. Yes 4.5.0
tokenUrl The authentication token url. 4.5.0
loginType The login type.
  • cas-iam1
  • cas-iam2
  • oauth2-iam1
  • oauth2-iam2
 4.5.0
clientType The client type. 4.5.0
grantType The authentication type. 4.5.0
urlTemplate The address jumped to after authentication. Yes 4.5.0
resourceUuid The resource UUID. Yes 4.5.0
tagUuids The tag UUID list. Yes 4.5.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.5.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.5.0
userinfoUrl The user information url. Yes 4.7.21
redirectUrl The redirect url. Yes 4.7.21
logoutUrl The logout url. Yes 4.7.21
scopeList The permission scope. Yes 5.1.8
identityProvider The identity provider. Yes 5.1.8
pluginUuid The plugin UUID. Yes 5.3.28

UpdateOAuthClient

Updates an OAuth client. For example, 
UpdateOAuthClient uuid=006c15d05b774d4c92fad6f5f2fbcdeb

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 4.5.0
name The resource name. Yes 4.5.0
description The detailed in formation of the resource. Yes 4.5.0
clientId The client ID. Yes 4.5.0
clientSecret The client key. Yes 4.5.0
authorizationUrl The aunthentication url. Yes 4.5.0
tokenUrl The authentication token url. Yes 4.5.0
loginType The login type. Yes
  • cas-iam1
  • cas-iam2
  • oauth2-iam1
  • oauth2-iam2
 4.5.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.5.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.5.0
userinfoUrl The user information url. Yes 4.7.21
redirectUrl The redirect url. Yes 4.7.21
logoutUrl The logout url. Yes 4.7.21
scopeList The permission scope. Yes 5.1.8
identityProvider The identity provider. Yes 5.1.8
pluginUuid The plugin UUID. Yes 5.3.28

GetOAuth2Token

Obtains the OAuth2 token. For example, 
GetOAuth2Token

Parameters

Name Description Optional Valid Value Starting Version
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.5.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.5.0
timeout Yes

CreateCasClient

Creates a CAS client. For example, 
CreateCasClient name=test casServerLoginUrl=http://zstack.com/login casServerUrlPrefix=http://zstack.com serverName=http://127.0.0.1:8080 loginType=cas-iam1

Parameters

Name Description Optional Valid Value Starting Version
name The resource name. 4.5.0
description The detailed information of the resource. Yes 4.5.0
casServerLoginUrl The CAS server login url. 4.5.0
casServerUrlPrefix The CAS server url prefix. 4.5.0
serverName The mn address (http://{mn_ip:port}/8080) Yes 4.5.0
loginType The login type.
  • cas-iam1
  • cas-iam2
  • oauth2-iam1
  • oauth2-iam2
 4.5.0
urlTemplate The address jumped to after the authentication. Yes 4.5.0
resourceUuid The resource UUID. Yes 4.5.0
tagUuids The tag UUID list. Yes 4.5.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.5.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.5.0
timeout Yes

UpdateCasClient

Updates a CAS client. For example, 
UpdateCasClient uuid=7239a7e6631648f8be137a92eb6bd702

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 4.5.0
description The detailed information of the resource. Yes 4.5.0
name The resource name. Yes 4.5.0
casServerLoginUrl The CAS server login url. Yes 4.5.0
casServerUrlPrefix The CAS server url prefix. Yes 4.5.0
serverName The mn address (http://{mn_ip:port}/8080) Yes 4.5.0
loginType The login type. Yes
  • cas-iam1
  • cas-iam2
  • oauth2-iam1
  • oauth2-iam2
 4.5.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.5.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.5.0
timeout Yes

DeleteSSOClient

Deletes an SSO client. For example, 
DeleteSSOClient uuid=0661b8ce0aef4fbd99078ae8c18e8605

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 4.5.0
deleteMode The deletion mode. Yes
  • Permissive
  • Enforcing，Permissive
 4.5.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.5.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.5.0
timeout Yes

GetSSOClient

Obtains an SSO client. For example, 
GetSSOClient

Parameters

Name Description Optional Valid Value Starting Version
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.5.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.5.0
timeout Yes

UpdateSSORedirectTemplate

Update the SSO redirect template. For example,
UpdateSSORedirectTemplate uuid=006c15d05b774d4c92fad6f5f2fbcdeb redirectTemplate=http://172.24.245.121:5000

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 4.7.21
redirectTemplate The UI redirect template. 4.7.21
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.7.21
userTags The user tags. For more information, see CreateUserTag. Yes 4.7.21
PreviousTicketNextTags
CLI Command Manual | 5.4.12 | ZStack Cloud · ZCF | ZStack Resource Center