ユーザーグループエンドポイント
ユーザーグループのエンドポイントとパラメーター
オブジェクト関係に関する詳細とAPIでの使用方法については、 オブジェクト関係 のセクションを参照してください。
カスタムグループの詳細については、 ユーザーとグループの管理 のヘルプページを参照してください。
新しいユーザーグループを作成する
新しいユーザーレコードを作成するには、
POST {baseURL}/v3/usergroups
エンドポイントを使用します。
パラメーター
新しいユーザーグループを作成するには、contractパラメーターを指定します。
contract (本文): 必須です。ユーザーグループのパラメーターを指定します。
name (文字列): 必須です。ユーザーグループ名を入力します。
role (文字列): 必須です。ユーザーグループのロールを入力します。次のオプションから選択します: 「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'
ユーザーをユーザーグループに追加する
1人以上のユーザーをユーザーグループに追加するには、
POST {baseURL}/v3/usergroups/{id}/users
エンドポイントを使用します。
パラメーター
ユーザーをユーザーグループに追加するには、次のパラメーターを指定します。
id (文字列): 必須です。ユーザーを追加するユーザーグループのIDを入力します。
userIds (本文): 必須です。このユーザーグループに追加するユーザーIDを入力します。
リクエストの例: cURL
追加予定。
すべてのカスタムユーザーグループを取得する
ユーザーを検索するには、
GET {baseURL}/v3/usergroups
エンドポイントを使用します。ユーザーを検索するためのフィルターとしてさまざまなパラメーターを使用します。
注記
カスタムユーザーグループのみが取得されます。Active Directoryのグループは返されません。
パラメーター
パラメーターは不要です。
リクエストの例: cURL
curl --location --request GET 'http://localhost/webapi/v3/usergroups' \ --header 'Authorization: Bearer BearerTokenGoesHere'
特定のユーザーグループを検索する
特定のユーザーグループに関する情報を取得するには、
GET {baseURL}/v3/usergroups/{id}
エンドポイントを使用します。
注記
カスタムユーザーグループに対してのみ機能します。このエンドポイントからActive Directoryのグループは取得できません。
パラメーター
id (文字列): 必須です。ユーザーグループIDを入力して、そのユーザーグループに関する情報を取得します。
リクエストの例: cURL
curl --location --request GET 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069' \ --header 'Authorization: Bearer BearerTokenGoesHere'
ユーザーグループを更新する
既存のユーザーグループの名前とロールを更新するには、
PUT {baseURL}/v3/usergroups/{id}
エンドポイントを使用します。
パラメーター
id (文字列): 必須です。ユーザーグループIDを入力して、このユーザーグループを更新します。
contract (本文): 必須です。ユーザーグループを更新するには、contractパラメーターが必要です。次の項目を指定します。
name (文字列): 必須です。ユーザーグループ名を入力します。
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'
ユーザーをユーザーグループから削除する
特定のユーザーをユーザーグループから削除するには、
DELETE {baseURL}/v3/usergroups/{userGroupId}/users/{userId}
エンドポイントを使用します。
注記
そのユーザーがグループに属していない場合は、OK応答が返されます。
パラメーター
userGroupId (文字列): 必須です。ユーザーを削除するユーザーグループのIDを入力します。
userId (文字列): 必須です。ユーザーグループから削除するユーザーIDを入力します。
リクエストの例: cURL
curl --location --request DELETE 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069/users/61d564361d6d5da7ad461a32' \ --header 'Authorization: Bearer BearerTokenGoesHere'
ユーザーグループを削除する
システムから特定のユーザーグループを削除するには、
DELETE {baseURL}/v3/usergroups/{id}
エンドポイントを使用します。
注記
ユーザーグループが空でなく、forceDeleteクエリパラメーターがfalseの場合、「400 Bad Request」エラーメッセージが返されます。
パラメーター
id (文字列): 必須です。削除するユーザーグループIDを入力します。
forceDelete (ブール型): オプションです。trueに設定すると、このユーザーグループにユーザーが含まれていても、ユーザーグループは削除されます。
リクエストの例: cURL
curl --location --request DELETE 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069?forceDelete=true' \ --header 'Authorization: Bearer BearerTokenGoesHere'
オブジェクト関係
ユーザーグループを作成する場合、作成したオブジェクトを次のように使用することができます。
作成されたオブジェクト: " id " (例えば、"id": "619158e57e607d0011ac3009")
次のように使用できます。
ユーザーグループをコレクションに追加 する場合、 userGroupId として。
コレクションのユーザーグループ権限を更新 する場合、 userGroupId として。
ユーザーグループをコレクションから削除 する場合、 userGroupId として。
ユーザーグループと資格情報を共有 する場合、 userGroupId として。
ユーザーグループを資格情報から削除 する場合、 userGroupId として。
ユーザーグループをデータ接続に追加 する場合、 userGroupId として。
ユーザーグループをデータ接続から削除 する場合、 userGroupId として。
Postmanリクエストの例
POST /v3/usergroups
DELETE /v3/usergroups/{userGroupId}/users/{userId}
Postmanリクエストの詳細については、 Postmanの使用方法 のヘルプページを参照してください。