ユーザーグループエンドポイント
Serverユーザーグループエンドポイントとパラメーター
オブジェクト関係に関する詳細とAPIでの使用方法については、 オブジェクト関係 のセクションを参照してください。
Serverユーザーグループの詳細については、 ユーザーとグループの管理 のヘルプページを参照してください。
新しいServerユーザーグループを作成する
新しいServerユーザーグループを作成するには、
POST {baseURL}/v3/usergroups
エンドポイントを使用します。
パラメーター
新しいServerユーザーグループを作成するには、contractパラメーターを指定します。
contract (本文): 必須です。Serverユーザーグループのパラメーターを指定します。
name (文字列): 必須です。Serverユーザーグループ名を入力します。
role (文字列): 必須です。Serverユーザーグループのロールを入力します。次のオプションから選択します: 「NoAccess」(アクセス権なし)、「Viewer」(ビューワー)、「Member」(メンバー)、「Artisan」(クリエイター)、「Curator」(管理者)、「Evaluated」(評価済み)。既定(Evaluated)ロールは実行時に評価されます。ロールと権限の詳細については、 ユーザーロールと権限 のページを参照してください。
リクエストの例: cURL
curl --location --request POST 'http://localhost/webapi/v3/usergroups' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'name=Accounting' \ --data-urlencode 'role=Artisan'
ユーザーをServerユーザーグループに追加する
1人以上のユーザーをServerユーザーグループに追加するには、
POST {baseURL}/v3/usergroups/{id}/users
エンドポイントを使用します。
パラメーター
Serverユーザーグループにユーザーを追加するには、次のパラメーターを指定します。
id (文字列): 必須です。ユーザーを追加するServerユーザーグループのIDを入力します。
userIds (本文): 必須です。このServerユーザーグループに追加するユーザーIDを入力します。
Active DirectoryのグループをServerユーザーグループのメンバーとして追加する
Active DirectoryのグループをServerユーザーグループのメンバーとして追加するには、
POST /v3/usergroups/{id}/activedirectorygroups
エンドポイントを使用します。
注記
このエンドポイントは、Windows 認証構成済みサーバーインスタンスにのみ使用できます。
パラメーター
id (文字列): 必須です。Active Directoryのグループを追加する既存のServerユーザーグループのIDを入力します。
sid (文字列): 必須です。Active Directoryのグループのセキュリティ識別子(SID)を入力します。値は引用符で囲んで送信する必要があります(例: “S-My-SID”)。
すべてのServerユーザーグループを取得する
ユーザーを検索するには、
GET {baseURL}/v3/usergroups
エンドポイントを使用します。ユーザーを検索するためのフィルターとしてさまざまなパラメーターを使用します。
注記
Serverユーザーグループのみが取得されます。Active Directoryのグループは返されません。
パラメーター
パラメーターは不要です。
リクエストの例: cURL
curl --location --request GET 'http://localhost/webapi/v3/usergroups' \ --header 'Authorization: Bearer BearerTokenGoesHere'
特定のServerユーザーグループを検索する
特定のServerユーザーグループに関する情報を取得するには、
GET {baseURL}/v3/usergroups/{id}
エンドポイントを使用します。
注記
Serverユーザーグループに対してのみ機能します。このエンドポイントからActive Directoryのグループは取得できません。
パラメーター
id (文字列): 必須です。ServerユーザーグループIDを入力して、そのユーザーグループに関する情報を取得します。
リクエストの例: cURL
curl --location --request GET 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Serverユーザーグループを更新する
既存のServerユーザーグループの名前とロールを更新するには、
PUT {baseURL}/v3/usergroups/{id}
エンドポイントを使用します。
パラメーター
id (文字列): 必須です。ServerユーザーグループIDを入力して、そのユーザーグループを更新します。
contract (本文): 必須です。Serverユーザーグループを更新するには、contractパラメーターが必要になります。次の項目を指定します。
name (文字列): 必須です。Serverユーザーグループ名を入力します。
role (文字列): 必須です。次のオプションから選択できます: 「NoAccess」(アクセス権なし)、「Viewer」(ビューワー)、「Member」(メンバー)、「Artisan」(クリエイター)、「Curator」(管理者)、「Evaluated」(評価済み)。ロールと権限の詳細については、 ユーザーロールと権限 のページを参照してください。
リクエストの例: cURL
curl --location --request PUT 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'name=Marketing' \ --data-urlencode 'role=Artisan'
ユーザーをServerユーザーグループから削除する
特定のユーザーをServerユーザーグループから削除するには、
DELETE {baseURL}/v3/usergroups/{userGroupId}/users/{userId}
エンドポイントを使用します。
注記
そのユーザーがグループに属していない場合は、OK応答が返されます。
パラメーター
userGroupId (文字列): 必須です。ユーザーを削除するServerユーザーグループのIDを入力します。
userId (文字列): 必須です。Serverユーザーグループから削除するユーザーIDを入力します。
リクエストの例: cURL
curl --location --request DELETE 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069/users/61d564361d6d5da7ad461a32' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Active DirectoryのグループをServerユーザーグループのメンバーから削除する
Active DirectoryのグループをServerユーザーグループのメンバーから削除するには、
DELETE /v3/usergroups/{userGroupId}/activedirectorygroups/{adGroupSid}
エンドポイントを使用します。
注記
このエンドポイントは、Windows 認証構成済みサーバーインスタンスにのみ使用できます。
パラメーター
userGroupId (文字列): 必須です。Active Directoryのグループを削除するServerユーザーグループの識別子を入力します。
adGroupSid (文字列): 必須です。Serverユーザーグループから削除するActive Directoryのグループのセキュリティ識別子(SID)を入力します。
Serverユーザーグループを削除する
システムから特定のServerユーザーグループを削除するには、
DELETE {baseURL}/v3/usergroups/{id}
エンドポイントを使用します。
注記
Serverユーザーグループが空でなく、forceDeleteクエリパラメーターがfalseの場合、「400 Bad Request」のエラーメッセージが返されます。
パラメーター
id (文字列): 必須です。削除するServerユーザーグループIDを入力します。
forceDelete (ブール型): オプションです。trueに設定すると、そのServerユーザーグループは、ユーザーが含まれていても削除されます。
リクエストの例: cURL
curl --location --request DELETE 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069?forceDelete=true' \ --header 'Authorization: Bearer BearerTokenGoesHere'
オブジェクト関係
Serverユーザーグループを作成する場合、作成したオブジェクトを次のように使用することができます。
作成されたオブジェクト: " id " (例えば、"id": "619158e57e607d0011ac3009")
次のように使用できます。
Serverユーザーグループをコレクションに追加する 場合、 userGroupId として。
コレクションのServerユーザーグループ権限を更新する 場合、 userGroupId として。
Serverユーザーグループをコレクションから削除する 場合、 userGroupId として。
Serverユーザーグループと資格情報を共有する 場合、 userGroupId として。
Serverユーザーグループを資格情報から削除する 場合、 userGroupId として。
Serverユーザーグループをデータ接続に追加する 場合、 userGroupId として。
Serverユーザーグループをデータ接続から削除する 場合、 userGroupId として。
Postmanリクエストの例
POST /v3/usergroups
DELETE /v3/usergroups/{userGroupId}/users/{userId}
Postmanリクエストの詳細については、「 Postmanの使用方法 」ヘルプページを参照してください。