用户管理 API

此功能仅适用于 Incredibuild 的 Enterprise Plan

您可以使用我们的 User Management API 创建新用户。该过程需要 API 密钥和企业许可证。使用此 API 创建的用户获授予 Viewer 权限。

请求端点

POST https://{IB Coordinator IP Address/Hostname}:{Web Access Port}/api/users/createViewers?version={api version}

版本是 Incredibuild API 版本对于此版本的 Incredibuild,API 版本为 1.3.0,但此 API 也支持 1.2.0 版。如果在 API 调用中没有指定版本,则将使用支持的最低版本。

例如:

POST https://coordinatorPC:8000/api/users/createViewers?version=1.3.0

请求格式:

标题:标题必须包含一个名为 client-api-key 的密钥和 API 密钥值字符串。所有 API 需要区分大小写。

主体:请求主体是一个用户数组,其中每个项目包含以下字段(有些字段可选)。每个请求最多可以包含 15 个新用户。

字段 描述 必要条件 数据类型
用户名 登录用户名 字符串
firstName 用户名姓氏 字符串
lastName   字符串
电子邮件地址   电子邮件格式字符串
密码   字符串。必须至少有 8 个字符,至少有一个大写字母,没有空格或特殊字符。

主体示例

复制
{

 [{

"userName": "Linda236watt",

"firstName": "Linda",

"lastName": "Watt",

"email":  "Linda236watt@gmail.com",

"password": "string"
 
},

{

"username": "Jane.Austen",

"firstName": "Jane",

"lastName": "A",

"email": "Jane.Austen@yahoo.com",

"password": "string"

},
 

{

"username": "AlexChampion",

"firstName": "Alexandar",

"lastName": "Champion",

"email": "alex@yahoo.com",

"password": "string"

}

]

}