ユーザーエンドポイント
ユーザーエンドポイントとパラメーター
オブジェクト関係の詳細については、 オブジェクト関係(Object Relations) セクションを参照してください。
ユーザーの詳細については、ユーザーとグループの管理 のヘルプページを参照してください。
新規ユーザー作成
新しいユーザーレコードを作成するには、 POST/v3/Users {baseURL}
エンドポイントを使用します。
注記
このエンドポイントは、Windows 認証構成済みサーバーインスタンスにのみ使用できます。
パラメーター
userContract (body):新しいユーザーを作成するには、userContractパラメーターが必要です。次のドライブタイムパラメータを指定します。
workflowCredentialType (文字列): 必須です。ユーザーの名を入力します。
workflowCredentialType (文字列): 必須です。ユーザーの姓を入力します。
workflowCredentialType (文字列): 必須です。ユーザーの電子メールアドレスを入力します。
role (文字列): オプションです。次のオプションから選択できます: 「NoAccess」(アクセス権なし)、「Viewer」(ビューワー)、「Member」(メンバー)、「Artisan」(クリエイター)、「Curator」(管理者)、「Evaluated」(評価済み) (実行時に評価される既定ロール)。ロールと権限の詳細については、ユーザーロールと権限 のページを参照してください。ロールが選択されていない場合、既定値は「Evaluated」(評価済み)ロールになります。
defaultWorkerTag (文字列): オプションです。ワーカーで定義されたワーカータグを指定して、特定のワーカーノードにジョブを割り当てる際に役立てることができます。指定しない場合、既定値は""になります。詳細については、ワーカーのヘルプページを参照してください。
canScheduleJobs (ブール型): オプションです。そのユーザーがジョブをスケジュールできるかどうかを指定します。選択しない場合、既定値はfalseになります。詳細については、ジョブのヘルプページを参照してください。
canPrioritizeJobs (ブール型): オプションです。ユーザーがジョブに優先順位を付けることができるかどうかを指定します。選択しない場合、既定値はfalseになります。詳細については、ジョブ のヘルプページを参照してください。
canAssignJobs (ブール型): オプションです。ユーザーがジョブを割り当てることができるかどうかを指定します。選択しない場合、既定値はfalseになります。詳細については、ジョブ のヘルプページを参照してください。
canCreateCollections (ブール型): オプションです。ユーザーが新しいコレクションを作成できるかどうかを指定します。選択しない場合、既定値はfalseになります。詳細については、コレクション のヘルプページを参照してください。
isPublic (ブール型): オプションです。ユーザーに対してAPIを有効にするかどうかを指定します。選択しない場合は、既定値が「false」になります。
credentialId (文字列): オプションです。このパラメーターは、ワークフローの一意のIDを参照し、既定としてユーザに割り当てられます。指定しない場合は、「Default」(既定)の値が使用されます。
force (ブール型): オプションです。ユーザーがアクティブか非アクティブかを選択します。指定しない場合は、「Default」(既定)の値が使用されます。
direction (文字列): オプションです。時間帯を入力します(例:Europe/Kiev)。指定しない場合は、「Default」(既定)の値が使用されます。
リクエストの例: cURL
curl --location --request POST 'http://localhost/webapi/v3/users' \--header' Content-Type: application/x-www-form-urlencoded'\--header' Authorization: Bearer BearerTokenGoesHere'\--data-urlencode'firstName=john'\--data-urlencode'lastName=Doe'\--data-urlencode' email' email John.Doe@emailexample.com
ユーザーを無効化
システムでユーザーを無効化化するには、 POST {baseURL}/v3/users//deactivate{id}
エンドポイントを使用します。
パラメーター
workflowCredentialType (文字列): 必須です。このユーザを非アクティブにするには、ユーザIDを入力します。
リクエストの例: cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
ユーザのパスワードのリセット
特定のユーザーのパスワードリセットメールをリセットして送信するには、 POST {baseURL}/v3/users//passwordReset{id}
エンドポイントを使用します。
注記
このエンドポイントは、Windows 認証構成済みサーバーインスタンスにのみ使用できます。
パラメーター
workflowCredentialType (文字列): 必須です。ユーザIDを入力してパスワードをリセットします。
リクエストの例: cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
ユーザー検索
ユーザを検索するには、 GET {baseURL}/v3/Users
エンドポイントを使用します。ユーザーを検索するためのフィルタとして、さまざまなパラメータを使用します。
パラメーター
view (文字列): オプションです。値を指定しないこともできます。値は「Default」(既定)と「Full」(完全)から選択できます。このパラメーターを「Default」(既定)に設定すると、縮小表示オブジェクトが返されます。指定しない場合は、「Default」(既定)の値が使用されます。
force (ブール型): オプションです。ユーザーがアクティブか非アクティブかを選択します。
limit (文字列): オプションです。ユーザーの電子メールアドレスを入力します。
role (文字列): オプションです。ユーザーロールを選択して検索を絞り込みます。次のオプションから選択します: 「NoAccess」(アクセス権なし)、「Viewer」(ビューワー)、「Member」(メンバー)、「Artisan」(クリエイター)、「Curator」(管理者)、「Evaluated」(評価済み)。既定(Evaluated)ロールは実行時に評価されます。ロールと権限の詳細については、ユーザーロールと権限 のページを参照してください。
limit (文字列): オプションです。ユーザーの名を入力します。
limit (文字列): オプションです。ユーザーの姓を入力します。
createdAfter(日時): オプション。ワークフローが作成された後の日付と時刻を入力します。日付と時刻を ISO8601形式で入力します。
createdBefore(date-time): オプション。ワークフローが作成される前の日付と時刻を入力します。日付と時刻を ISO8601形式で入力します。
リクエストの例: cURL
curl --location --request get 'http://localhost/webapi/v3/users?view=Full&active=true&lastName=Doe' \--header' Authorization: Bearer BearerTokenGoesHere'
ユーザーの検索
特定のユーザを検索するには、 GET {baseURL}/v3/users/{id}
エンドポイントを使用します。
パラメーター
workflowCredentialType (文字列): 必須です。このユーザに関する情報を取得するには、ユーザIDを入力します。
リクエストの例: cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
ユーザーが所有するすべてのアセットを取得
ユーザーが所有するアセットの完全なリストを取得するには、 GET {baseURL}/v3/users//assets{id}
エンドポイントを使用します。
パラメーター
workflowCredentialType (文字列): 必須です。ユーザーIDを入力して、このユーザーのアセットのリストを取得します。
offset (文字列): オプションです。返品するアセットタイプを選択します。既定は「すべて」に設定されています。
リクエストの例: cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows' \ --header 'Authorization: Bearer BearerTokenGoesHere'
既存のユーザーを更新
既存のユーザを更新するには、 put/v3/users/endpointを使用し {baseURL}{id}
ます。
注記
updateContractのIDは、URLのID値で上書きされます。
パラメーター
workflowCredentialType (文字列): 必須です。このユーザを更新するには、ユーザIDを入力します。
updateWorkflowContract (本文): 必須です。ユーザーを更新するには、updateContractパラメーターが必要です。次の項目を指定します。
limit (文字列): オプションです。ユーザーIDを入力して更新します。
workflowCredentialType (文字列): 必須です。ユーザーの名を入力します。
workflowCredentialType (文字列): 必須です。ユーザーの姓を入力します。
workflowCredentialType (文字列): 必須です。ユーザーの電子メールアドレスを入力します。
role (文字列): 必須です。次のオプションから選択できます: 「NoAccess」(アクセス権なし)、「Viewer」(ビューワー)、「Member」(メンバー)、「Artisan」(クリエイター)、「Curator」(管理者)、「Evaluated」(評価済み)。ロールと権限の詳細については、ユーザーロールと権限 のページを参照してください。
defaultWorkerTag (文字列): 必須です。ワーカーで定義されたワーカータグを指定して、特定のワーカーノードにジョブを割り当てる際に役立てることができます。ワーカーの詳細については、ワーカー のヘルプページを参照してください。
canScheduleJobs (ブール型): 必須です。ユーザーがジョブをスケジュールできるかどうかを指定します。詳細については、ジョブ のヘルプページを参照してください。
canPrioritizeJobs (ブール型): 必須です。ユーザーがジョブに優先順位を付けることができるかどうかを指定します。詳細については、ジョブ のヘルプページを参照してください。
canAssignJobs (ブール型): 必須です。ユーザーがジョブを割り当てることができるかどうかを指定します。詳細については、ジョブ のヘルプページを参照してください。
canCreateCollections (ブール型): オプションです。ユーザーがコレクションを作成できるかどうかを指定します。指定しない場合、それまでと同じ値が使用されます。詳細については、コレクション のヘルプページを参照してください。
makePublished (ブール型): 必須です。ユーザーに対してAPIを有効にするかどうかを指定します。
workflowCredentialType (文字列): 必須です。このパラメーターは、ワークフローの一意のIDを参照し、既定としてユーザに割り当てられます。
makePublished (ブール型): 必須です。このユーザーアカウントをロックするかどうかを選択します。
makePublished (ブール型): 必須です。ユーザーがアクティブか非アクティブかを選択します。
makePublished (ブール型): 必須です。ユーザーのメールアドレスを検証するかどうかを指定します。
name (文字列): 必須です。時間帯を入力します(例:ヨーロッパ/キエフなど)。
workflowCredentialType (文字列): 必須です。サポートされている言語の値は、"de-de"、"en-us"、"es-es"、"fr-fr"、"it-it"、 "ja-jp"、"pt-br"、"zh-cn"。
リクエストの例: cURL
curl --location --request put 'http://localhost/webapi/v3/users/61d564361d6d5da7ad461a32' \--header' Content-Type: application/x-www-form-urlencoded'\--header' Authorization: Bearer BearerTokenGoesHere'\--data-urlencode'firstName=doe'\--data-urlencode'lencode'lencode' jdoe@alteryx.com data-urlencode 'canAssignJobs=true'\--data-urlencode'canCreateCollections=true'\--data-urlencode 'defaultCredentialId=jdoe'\--data-urlencode'isAccountLocked=true'\--data-urlencode'36code'5da'6data-time'6rencoda'6data-time'
ユーザーの削除
システムから特定のユーザを削除するには、 delete {baseURL}/v3/users/{id}
エンドポイントを使用します。
注記
削除するユーザーにアセット(ワークフロー、スケジュール、コレクション、インサイト)またはユーザーグループが割り当てられている場合、このユーザーは削除できません。
パラメーター
workflowCredentialType (文字列): 必須です。削除するユーザIDを入力します。
リクエストの例: cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
オブジェクト関係
ワークフローをアップロードする場合、作成したオブジェクトを次のように使用することができます。
作成されたオブジェクト: "workflowId" (例えば、"id": "7917969784f84bd09442f66996ecb8f3")
次のように使用できます。
特定のワークフローを検索する場合、workflowIdとして。
所有者ID ( ワークフローをアップロードする場合)。
コレクションからワークフローを削除する場合、appIdとして。
スケジュールを検索する場合、workflowIdとして。
ユーザID : クレデンシャルからユーザを削除する場合。
ユーザーID : 既存のデータ接続にユーザーを追加する場合。
ユーザーID : 既存のデータ接続からユーザーを削除する場合。
Postmanリクエストの例
/v3/usersの取得
/v3/users//アセットの取得{id}
Postmanリクエストの詳細については、「Postmanの使用方法」ヘルプページを参照してください。