ユーザー管理API
この機能は、Incredibuild のEnterprise Plan でのみ利用可能です。
ユーザー管理APIを使って新しいユーザーを作成することができます。この作業にはAPI キー 、Enterpriseライセンスが必要です。このAPIを使用して作成されたユーザーには、閲覧 権限が付与されます。
リクエストエンドポイント
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は大文字と小文字を区別します。
本文： リクエスト本文はユーザーの配列で、各項目は以下のフィールドを含む(いくつかはオプション)。1つのリクエストにつき、最大15人の新規ユーザーを含めることができます。
| フィールド | 説明 | 必須 | データタイプ |
|---|---|---|---|
| userName | ログイン用ユーザー名 | Yes | string |
| firstName | ユーザーの名 | No | string |
| lastName | No | string | |
| No | メールフォーマットの文字列 | ||
| password | Yes | 文字列。8文字以上、大文字1文字以上、スペースや特殊文字は使用しないでください。 |
本文の例
{
[{
"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"
}
]
}