Model对象定义
Project
参数名称 |
类型 |
描述 |
id |
String |
项目id |
name |
String |
项目名 |
alias |
String |
项目登录地址前缀 |
comment |
String |
项目描述 |
status |
Integer |
项目状态,1表示启用,0表示禁用,创建成功后默认为启用状态 |
OrganizationUnit
参数名称 |
类型 |
描述 |
id |
String |
项目id |
organizationId |
String |
组织单元所属的组织id |
name |
String |
组织名 |
comment |
String |
组织描述 |
code |
String |
组织单元代号 |
status |
Integer |
组织单元状态,1表示启用,0表示废弃 |
parentId |
String |
上级组织单元id |
parentName |
String |
上级组织单元名称 |
User
参数名称 |
类型 |
描述 |
id |
String |
用户id |
name |
String |
用户登录名 |
displayName |
String |
用户展示名 |
sourceType |
String |
用户来源,CREATE表示手动创建,IMPORT表示导入 |
comment |
String |
用户描述 |
status |
Integer |
用户状态,1表示有效,0表示禁用 |
mobilePhone |
String |
用户手机号 |
mobileVerified |
Boolean |
手机号是否验证 |
email |
String |
用户邮箱 |
emailVerified |
Boolean |
邮箱是否验证 |
organizationUnitName |
String |
用户所属组织单元名称 |
organizationUnitId |
String |
用户所属组织单元id |
passwordSetted |
Boolean |
用户是否设置密码 |
Provider
参数名称 |
类型 |
描述 |
id |
String |
认证源id |
name |
String |
认证源名称 |
comment |
String |
AD 认证源描述 |
bindType |
String |
建绑方式:NAME/ID |
organizationUnitId |
String |
认证源绑定的ouId |
authType |
String |
认证协议,支持LDAP,OIDC,JWT |
authConfig |
Object |
由协议类型决定,见AuthConfig |
status |
Integer |
认证源状态,1为启用,0为禁用,创建后默认为禁用状态 |
Application
参数名称 |
类型 |
描述 |
id |
String |
应用id |
name |
String |
用户登录名,不可修改 |
comment |
String |
用户描述 |
icon |
String |
项目图表 |
type |
tring |
应用类型:Custom为客户创建应用 |
loginType |
String |
登录三方应用的SSO协议 |
loginConfig |
String |
协议配置,由协议类型决定,见LoginConfig |
SyncConfig
参数名称 |
类型 |
描述 |
targetId |
String |
应用或者认证源的id |
projectId |
String |
项目id |
targetType |
String |
APP 同步目标的类型 APP/PROVIDER |
targetActorType |
String |
SUBUSER 目标实体类型 OU/ACCOUNT/SUBUSER/ROLE |
protocol |
String |
SCIM 同步协议 SCIM/LDAP |
mapping |
Object |
见Mapping |
permission |
List |
用户权限列表 |
status |
Integer |
是否开启同步,1为开启,0为不开启 |
syncDirection |
String |
同步方向 FROM_IDAAS/TO_IDAAS |
Resource
参数名称 |
类型 |
描述 |
id |
String |
资源的id |
name |
String |
资源的名称 |
parentId |
String |
资源的父级资源id |
psId |
String |
资源所在的权限系统id |
AuthorizationResponse
参数名称 |
类型 |
描述 |
authorized |
Boolean |
鉴权是否通过; 通过返回true,否则返回false |
AuthConfig
根据认证协议分为三种
LDAP协议的AuthConfig
{
"type":"LDAP", // 协议类型,固定为LDAP
"saveSession":false, // 跳转三方应用后是否保存IDaaS登录状态,非必填,默认为false
"ldapType":"OPEN_LDAP", // LDAP服务器类型,OPEN_LDAP/WINDOWS_AD
"serverUrl":"180.180.180.180", // LDAP服务器地址,可配置端口如 180.180.180.180:389,不配置则默认使用389或者636端口
"baseDN":"dc=bcetest-ad,dc=com", // LDAP服务器中同步的root节点
"useSSL":false, // 同步过程是否使用SSL,需要LDAP服务器支持
"cacert": "xxx", // 如果勾选使用SSL,那么必须填入LDAP服务器的根证书
"adminDN":"cn=cixiao,ou=serverrd,ou=rd,ou=people,dc=bcetest-ad,dc=com", // LDAP服务器管理员DN
"adminPwd":"zcx123456", // LDAP服务器管理员密码
"syncOu":true, // 是否要同步组织,默认为true
"syncUser":true, // 是否同步用户,默认为true
"userBindingProperty":"uid" // 使用LDAP登录时,作为用户登录名的属性,openLDAP推荐使用uid,WindowsAD推荐使用UserPrincipleName
}
OIDC协议的AuthConfig
{
"type":"OIDC", // 协议类型,固定为OIDC
"clientId":"8320763d-435c-41be-9e9f-f615d0896a82", // OAuth服务器分配给IDaaS的clientId
"clientSecret":"98f2f37a-0067-472f-b6d9-7f327e38da8b", // OAuth服务器分配给IDaaS的clientSecret
"discoveryEndpoint":"https://www.baidu.com/baiduoauth/v1/oauth" // OAuth服务器的配置信息地址
}
JWT协议的AuthConfig
{
"type":"JWT", // 协议类型,固定为JWT
"mainSigningKey":"c56cb527217411eaa", // JWT的主签名密钥
"backUpSigningKey":"secret", // JWT的备用签名密钥
"tokenEndpoint":"http://nmg02-bce-test6.nmg02.baidu.com:8974/jwtlogin" // JWT认证源的认证地址
}
LoginConfig
SAML协议的LoginConfig
{
"type":"SAML", // 协议类型,固定为SAML
"spMetadata": {
"signAssertion":true, // 是否对断言进行签名
"encryptAssertion":true, // 是否对断言进行加密
"encryptionCert":"", // 加密断言用的公钥证书
"spEntityId":"urn:bcetest:baidu:webservices", // 三方应用的spEntityId
"acsUrl":"https://login.bcetest.baidu.com/saml", // 三方应用的SAML登录接口
"binding":"POST", // binding方式,支持POST,REDIRECT和ARTIFACT
"relayState":"testrelay", // relayState参数值
"attributes":{ // 断言中的属性列表,支持动态模板
"https://bce.baidu.com/SAML/Attributes/Subuser":"${account}:subuser-id/${user}, ${account}:saml-provider/bce-idaas"
},
"nameIdFormat":"urn:oasis:names:tc:SAML:2.0:nameid-format:transient",// nameId的类型
"nameId":"abc" // nameId的值,支持动态模板
}
}
Mapping
{
"organizationUnitId":"aa02e77a9237409ea5e42493d610f795", // IDaaS组织单元id
"targetOrganizationId":"41c18a996613428ca7e4b019a667d949", // 外部组织id,选填
"targetOrganizationUnitId":"41c18a996613428ca7e4b019a667d949" // 外部组织单元id
}