统一认证SSO相关操作
通过AD/LDAP用户DN创建IAM2用户(CreateIAM2VirtualIDFromLdapUid)
管理员可以使用CreateIAM2VirtualIDFromLdapUid从LDAP用户创建IAM2用户。
例如：
CreateIAM2VirtualIDFromLdapUid ldapUid=ou\u003dEmployee,uid\u003dtest参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| ldapUid | AD/LDAP用户UID | 3.5.1 | ||
| resourceUuid | 资源UUID | 是 | 3.5.1 | |
| tagUuids | 标签UUID列表 | 是 | 3.5.1 | |
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 3.5.1 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 3.5.1 | |
| timeout | 是 |
创建AD/LDAP用户和IAM2用户绑定关系(CreateIAM2VirtualIDLdapBinding)
管理员可以使用CreateIAM2VirtualIDLdapBinding绑定IAM2用户和LDAP用户。
例如：
CreateIAM2VirtualIDLdapBinding virtualIDUuid=5d1be61d0d1d3657afdd9e7829f4d2ed ldapUid=ou\u003dEmployee,uid\u003dtest参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| virtualIDUuid | IAM2用户UUID | 3.5.1 | ||
| ldapUid | AD/LDAP用户UUID | 3.5.1 | ||
| resourceUuid | 是 | 3.5.1 | ||
| tagUuids | 标签UUID列表 | 是 | 3.5.1 | |
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 3.5.1 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 3.5.1 | |
| timeout | 是 |
获取AD/LDAP认证可用用户条目(GetCandidateLdapEntryForIAM2Binding)
管理员可以使用GetCandidateLdapEntryForIAM2Binding获取可供IAM2用户绑定的LDAP条目。
例如：
GetCandidateLdapEntryForIAM2Binding ldapFilter=(cn=mevoco)参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| ldapFilter | AD/LDAP查询条件 | 3.5.1 | ||
| limit | AD/LDAP查询条数限制 | 是 | 3.5.1 | |
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 3.5.1 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 3.5.1 | |
| timeout | 是 |
通过AD/LDAP认证登录IAM2用户(LoginIAM2VirtualIDWithLdap)
管理员可以使用LoginIAM2VirtualIDWithLdap通过AD/LDAP认证登录IAM2用户。
例如：
LoginIAM2VirtualIDWithLdap uid=test password=password参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| uid | 平台指定的AD/LDAP用户登录属性值 | 3.5.1 | ||
| password | AD/LDAP用户登录密码 | 3.5.1 | ||
| verifyCode | 验证登录码 | 是 | 3.5.1 | |
| captchaUuid | 验证登录码UUID | 是 | 3.5.1 | |
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 3.5.1 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 3.5.1 | |
| timeout | 是 |
删除IAM2用户与AD/LDAP用户绑定关系(DeleteIAM2VirtualIDLdapBinding)
管理员可以使用DeleteIAM2VirtualIDLdapBinding删除IAM2用户与LDAP用户绑定关系。
例如：
DeleteIAM2VirtualIDLdapBinding uuid=0a7983d3082530c4b6d4b844e694694e参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| uuid | 资源的UUID，唯一标示该资源 | 3.5.1 | ||
| deleteMode | 是 | 3.5.1 | ||
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 3.5.1 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 3.5.1 | |
| timeout | 是 |
清除IAM2用户与AD/LDAP用户绑定关系(CleanInvalidLdapIAM2Binding)
管理员可以使用CleanInvalidLdapIAM2Binding清除IAM2用户与LDAP用户绑定关系。
例如：
CleanInvalidLdapIAM2Binding 参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 3.5.1 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 3.5.1 | |
| timeout | 是 |
查询AD/LDAP绑定(QueryIAM2LdapBinding)
管理员可以使用QueryIAM2LdapBinding查询IAM2用户的绑定。例如：
QueryIAM2LdapBinding 原生域查询（Primitive Fields of Query）
同步AD/LDAP服务器用户及组织(SyncLdapServer)
管理员可以使用SyncLdapServer同步AD/LDAP服务器用户及组织。
例如：
SyncLdapServer uuid=14dc461677b23ea1a984849f501a7152参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| uuid | 资源的UUID，唯一标示该资源 | 3.5.1 | ||
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 3.5.1 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 3.5.1 | |
| timeout | 是 |
创建OAuth客户端（CreateOAuthClient）
管理员可以使用CreateOAuthClient创建OAuth客户端。例如：
CreateOAuthClient name=test clientId=756770202fcd36bfbaa00ea7dea7f5ff tokenUrl=http://zstack.com/token loginType=oauth2-iam2 clientType=OAuth2 grantType=authorization_code参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| name | 资源名称 | 4.5.0 | ||
| description | 资源的详细描述 | 是 | 4.5.0 | |
| clientId | 客户端ID | 4.5.0 | ||
| clientSecret | 客户端密钥 | 是 | 4.5.0 | |
| authorizationUrl | 认证url | 是 | 4.5.0 | |
| tokenUrl | 认证token url | 4.5.0 | ||
| loginType | 登录的类型 |
|
4.5.0 | |
| clientType | client类型 | 4.5.0 | ||
| grantType | 认证模式 | 4.5.0 | ||
| urlTemplate | 认证之后跳转的地址 | 4.5.0 | ||
| clientType | 客户端类型 | 4.5.0 | ||
| resourceUuid | 资源UUID | 是 | 4.5.0 | |
| tagUuids | 标签UUID列表 | 是 | 4.5.0 | |
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 4.5.0 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 4.5.0 | |
| userinfoUrl | 请求用户信息地址 | 是 | 4.7.21 | |
| redirectUrl | 用户自定义回调地址 | 是 | 4.7.21 | |
| logoutUrl | 登出地址 | 是 | 4.7.21 | |
| scopeList | 权限范围 | 是 | 5.1.8 | |
| identityProvider | 认证供应商 | 是 | 5.1.8 | |
| pluginUuid | 供应商插件UUID | 是 | 5.3.28 |
更新OAuth客户端（UpdateOAuthClient）
管理员可以使用UpdateOAuthClient更新OAuth客户端。例如：
UpdateOAuthClient uuid=006c15d05b774d4c92fad6f5f2fbcdeb参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| uuid | 资源的UUID，唯一标识该资源 | 4.5.0 | ||
| name | 资源名称 | 是 | 4.5.0 | |
| description | 资源的详细描述 | 是 | 4.5.0 | |
| clientId | 客户端ID | 是 | 4.5.0 | |
| clientSecret | 客户端密钥 | 是 | 4.5.0 | |
| authorizationUrl | 认证url | 是 | 4.5.0 | |
| tokenUrl | 认证token url | 是 | 4.5.0 | |
| loginType | 登录的类型 | 是 |
|
4.5.0 |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 4.5.0 | |
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 4.5.0 | |
| redirectUrl | 用户自定义回调地址 | 是 | 4.7.21 | |
| userinfoUrl | 请求用户信息地址 | 是 | 4.7.21 | |
| logoutUrl | 登出地址 | 是 | 4.7.21 | |
| scopeList | 权限范围 | 是 | 5.1.8 | |
| identityProvider | 认证供应商 | 是 | 5.1.8 | |
| pluginUuid | 供应商插件UUID | 是 | 5.3.28 |
获取OAuth2 Token（GetOAuth2Token）
管理员可以使用GetOAuth2Token获取OAuth2
Token。例如：
GetOAuth2Token参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 4.5.0 | |
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 4.5.0 | |
| timeout | 是 |
创建CAS客户端（CreateCasClient）
管理员可以使用CreateCasClient创建CAS客户端。例如：
CreateCasClient name=test casServerLoginUrl=http://zstack.com/login casServerUrlPrefix=http://zstack.com serverName=http://127.0.0.1:8080 loginType=cas-iam1参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| name | 资源名称 | 4.5.0 | ||
| description | 资源的详细描述 | 是 | 4.5.0 | |
| casServerLoginUrl | casServerLoginUrl | 4.5.0 | ||
| casServerUrlPrefix | casServerUrlPrefix | 4.5.0 | ||
| serverName | mn的地址 (http://{mn_ip:port}/8080) | 是 | 4.5.0 | |
| loginType | 登录的类型 |
|
4.5.0 | |
| urlTemplate | 认证之后跳转的地址 | 是 | 4.5.0 | |
| resourceUuid | 资源UUID | 是 | 4.5.0 | |
| tagUuids | 标签UUID列表 | 是 | 4.5.0 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 4.5.0 | |
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 4.5.0 | |
| timeout | 是 |
更新CAS客户端（UpdateCasClient）
管理员可以使用UpdateCasClient更新CAS客户端。例如：
UpdateCasClient uuid=7239a7e6631648f8be137a92eb6bd702参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| uuid | 资源的UUID，唯一标示该资源 | 4.5.0 | ||
| description | 资源的详细描述 | 是 | 4.5.0 | |
| name | 资源名称 | 是 | 4.5.0 | |
| casServerLoginUrl | casServerLoginUrl | 是 | 4.5.0 | |
| casServerUrlPrefix | casServerUrlPrefix | 是 | 4.5.0 | |
| serverName | mn的地址(http://{mn_ip:port}/8080) | 是 | 4.5.0 | |
| loginType | 登录的类型 | 是 |
|
4.5.0 |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 4.5.0 | |
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 4.5.0 | |
| timeout | 是 |
删除认证客户端（DeleteSSOClient）
管理员可以使用DeleteSSOClient删除认证客户端。例如：
DeleteSSOClient uuid=0661b8ce0aef4fbd99078ae8c18e8605参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| uuid | 资源的UUID，唯一表示该资源 | 4.5.0 | ||
| deleteMode | 删除模式 | 是 |
|
4.5.0 |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 4.5.0 | |
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 4.5.0 | |
| timeout | 是 |
获取SSO客户端（GetSSOClient）
管理员可以使用GetSSOClient获取SSO客户端。例如：
GetSSOClient参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 4.5.0 | |
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 4.5.0 | |
| timeout | 是 |
修改重定向UI（UpdateSSORedirectTemplate）
管理员可以使用UpdateSSORedirectTemplate修改重定向UI。例如：
UpdateSSORedirectTemplate uuid=006c15d05b774d4c92fad6f5f2fbcdeb redirectTemplate=http://172.24.245.121:5000参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| uuid | 资源的UUID，唯一标识该资源 | 4.7.21 | ||
| redirectTemplate | UI重定向地址 | 4.7.21 | ||
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 4.7.21 | |
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 4.7.21 |