Skip to main content

ユーザーグループエンドポイント

ユーザーグループのエンドポイントとパラメーター

オブジェクト関係に関する詳細とAPIでの使用方法については、 オブジェクト関係 のセクションを参照してください。

Serverユーザーグループの詳細については、 ユーザーとグループの管理 のヘルプページを参照してください。

新しいユーザーグループを作成する

新しいユーザーグループを作成するには、 POST {baseURL}/v3/usergroups エンドポイントを使用します。

注記

このAPIエンドポイントを使用できるのは管理者のみです。

パラメーター

新しい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'

ユーザーをユーザーグループに追加する

1人以上の既存ユーザーを既存のユーザーグループに追加するには、 POST {baseURL}/v3/usergroups/{userGroupId}/users エンドポイントを使用します。

注記

このAPIエンドポイントを使用できるのは管理者のみです。

パラメーター

Serverユーザーグループにユーザーを追加するには、次のパラメーターを指定します。

  • userGroupId (文字列): 必須です。ユーザーを追加するユーザーグループのIDを入力します。

  • userIds (本文): 必須です。このユーザーグループに追加するユーザーIDのリストを、カンマで区切って入力します。

Active Directoryのグループをユーザーグループに追加する

Active Directoryのグループを既存のユーザーグループに追加するには、 POST /v3/usergroups/{userGroupId}/activedirectorygroups エンドポイントを使用します。

注記

このAPIエンドポイントを使用できるのは管理者のみです。

このエンドポイントは、Windows 認証構成済みサーバーインスタンスにのみ使用できます。

パラメーター

  • userGroupId (文字列): 必須です。Active Directoryのグループを追加する既存のユーザーグループのIDを入力します。

  • sid (文字列): 必須です。Active Directoryのグループのセキュリティ識別子(SID)を入力します。これはJSON本文のペイロードです。値は引用符で囲んで送信する必要があります(例: “S-My-SID”)。

すべてのユーザーグループを取得する

アクセス可能なすべてのユーザーグループのレコードを取得するには、 GET {baseURL}/v3/usergroups エンドポイントを使用します。ユーザーを検索するためのフィルターとしてさまざまなパラメーターを使用します。

注記

このAPIエンドポイントを使用できるのは管理者のみです。

カスタムユーザーグループのみが取得されます。Active Directoryのグループは返されません。

パラメーター

パラメーターは不要です。

リクエストの例: cURL

curl --location --request GET 'http://localhost/webapi/v3/usergroups' \ --header 'Authorization: Bearer BearerTokenGoesHere'

特定のユーザーグループの詳細を取得する

既存のユーザーグループの詳細を取得するには、 GET {baseURL}/v3/usergroups/{userGroupId} エンドポイントを使用します。

注記

このAPIエンドポイントを使用できるのは管理者のみです。

Serverユーザーグループに対してのみ機能します。このエンドポイントからActive Directoryのグループは取得できません。

パラメーター

  • userGroupId (文字列): 必須です。既存のユーザーグループIDを入力して、このユーザーグループに関する情報を取得します。

リクエストの例: cURL

curl --location --request GET 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069' \ --header 'Authorization: Bearer BearerTokenGoesHere'

ユーザーグループを更新する

既存のユーザーグループの名前とロールを更新するには、 PUT {baseURL}/v3/usergroups/{userGroupId} エンドポイントを使用します。

注記

このAPIエンドポイントを使用できるのは管理者のみです。

パラメーター

  • userGroupId (文字列): 必須です。ユーザーグループ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} エンドポイントを使用します。

注記

このAPIエンドポイントを使用できるのは管理者のみです。

ユーザーがそのユーザーグループに属していない場合は、OK応答が返されます。

パラメーター

  • userGroupId (文字列): 必須です。ユーザーを削除するユーザーグループのIDを入力します。

  • userId (文字列): 必須です。ユーザーグループから削除するユーザーIDを入力します。

リクエストの例: cURL

curl --location --request DELETE 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069/users/61d564361d6d5da7ad461a32' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Active Directoryのグループをユーザーグループから削除する

既存のユーザーグループからActive Directoryのグループを削除するには、 DELETE /v3/usergroups/{userGroupId}/activedirectorygroups/{adGroupSid} エンドポイントを使用します。

注記

このAPIエンドポイントを使用できるのは管理者のみです。

このエンドポイントは、Windows 認証構成済みサーバーインスタンスにのみ使用できます。

パラメーター

  • userGroupId (文字列): 必須です。Active Directoryのグループを削除するユーザーグループの識別子を入力します。

  • adGroupSid (文字列): 必須です。ユーザーグループから削除するActive Directoryのグループのセキュリティ識別子(SID)を入力します。

ユーザーグループを削除する

システムから既存のユーザーグループを削除するには、 DELETE {baseURL}/v3/usergroups/{userGroupId} エンドポイントを使用します。

注記

このAPIエンドポイントを使用できるのは管理者のみです。

ユーザーグループが空でなく、forceDeleteクエリパラメーターがfalseの場合、「400 Bad Request」エラーメッセージが返されます。

パラメーター

  • userGroupId (文字列): 必須です。削除するユーザーグループIDを入力します。

  • forceDelete  (ブール型): オプションです。trueに設定すると、このユーザーグループにユーザーが含まれていても、ユーザーグループは削除されます。

リクエストの例: cURL

curl --location --request DELETE 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069?forceDelete=true' \ --header 'Authorization: Bearer BearerTokenGoesHere'

オブジェクト関係

ユーザーグループを作成する場合、作成したオブジェクトを次のように使用することができます。

作成されたオブジェクト: " id " (例えば、"id": "619158e57e607d0011ac3009")

次のように使用できます。

Postmanリクエストの例

POST /v3/usergroups

Example of a POST request in Postman.

DELETE /v3/usergroups/{userGroupId}/users/{userId}

Example of a DELETE request in Postman.

Postmanリクエストの詳細については、「 Postmanの使用方法 」ヘルプページを参照してください。