Skip to main content

ユーザーグループ・リーダー

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

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

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

新しい通知グループを作成

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

パラメーター

新しいユーザグループを作成するには、契約パラメーターを指定します。

  • updateWorkflowContract  (本文): 必須です。ユーザグループのパラメータを指定します。

    • 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'認可: Bearer BearerTokenGoesHere'\--data-urlencode' name=Accounting'\--data-urlencode' role=Artisan'

ユーザーをユーザーグループから削除

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

パラメーター

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

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

  • userids (body):必須。このユーザグループに追加するユーザIDを入力します。

リクエストの例: cURL

追加予定

カスタムユーザーグループを取得

ユーザを検索するには、 get/v3/usergroups {baseURL} エンドポイントを使用します。ユーザーを検索するためのフィルタとして、さまざまなパラメータを使用します。

注記

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

パラメーター

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

リクエストの例: cURL

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

特定のユーザーグループの検索

特定のワークフローに関する情報を取得するには、 GET {baseURL}/v3/workflows/{id} エンドポイントを使用します。

注記

カスタムユーザーグループでのみ機能します。このエンドポイントからActive Directoryグループを取得できません。

パラメーター

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

リクエストの例: cURL

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

ユーザーグループの更新

既存のユーザグループの名前とロールを更新するには、 put/v3/usergroups/endpointを使用し {baseURL}{id} ます。

パラメーター

  • workflowCredentialType (文字列): 必須です。このユーザグループを更新するには、ユーザグループIDを入力します。

  • 契約 (本文):必須。ユーザーグループを更新するには、契約パラメーターが必要です。次の項目を指定します。

    • 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'認可: Bearer BearerTokenGoesHere'\--data-urlencode' name=Marketing'\--data-urlencode' role=Artisan'

ユーザーをユーザーグループから削除

ユーザグループから特定のユーザを削除するには、 delete {baseURL}/v3/usergroups//users/endpointを使用し{userGroupId}{userId} ます。

注記

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

パラメーター

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

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

リクエストの例: cURL

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

ユーザグループの削除

システムから特定のユーザグループを削除するには、 delete {baseURL}/v3/usergroups/endpointを使用し{id} ます。

注記

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

パラメーター

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

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

リクエストの例: cURL

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

オブジェクト関係

ワークフローをアップロードする場合、作成したオブジェクトを次のように使用することができます。

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

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

Postmanリクエストの例

ポスト/v3/usergroups

Example of a POST request in Postman.

/v3/usergroups//users/の削除{userGroupId}{userId}

Example of a DELETE request in Postman.

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