ユーザーエンドポイント
ユーザーエンドポイントとパラメーター
オブジェクト関係の詳細については、オブジェクト関係のセクションを参照してください。
ユーザーの詳細については、ユーザーとグループの管理のヘルプページを参照してください。
新規ユーザー作成
新しいユーザーレコードを作成するには、POST {baseURL}/v3/users エンドポイントを使用します。
注記
このエンドポイントは、Windows認証が設定されているServerインスタンスには使用できません。
パラメーター
userContract (本文): 新しいユーザーを作成するには、userContractパラメーターが必要です。次のパラメーターを指定します。
firstName (文字列): 必須です。ユーザーの名を入力します。
lastName (文字列): 必須です。ユーザーの姓を入力します。
email (文字列): 必須です。ユーザーのEメールアドレスを入力します。
role (文字列): オプションです。次のオプションから選択できます: 「NoAccess」(アクセス権なし)、「Viewer」(ビューワー)、「Member」(メンバー)、「Artisan」(クリエイター)、「Curator」(管理者)、「Evaluated」(評価済み) (実行時に評価される既定ロール)。ロールと権限の詳細については、ユーザーロールと権限のページを参照してください。ロールが選択されていない場合、既定値は「Evaluated」(評価済み)ロールになります。
defaultWorkerTag (文字列): オプションです。ワーカーで定義されたワーカータグを指定して、特定のワーカーノードにジョブを割り当てる際に役立てることができます。指定しない場合、既定値は""になります。詳細については、ワーカーのヘルプページを参照してください。
canScheduleJobs (ブール型): オプションです。そのユーザーがジョブをスケジュールできるかどうかを指定します。選択しない場合、既定値はfalseになります。詳細については、ジョブのヘルプページを参照してください。
canPrioritizeJobs (ブール型): オプションです。ユーザーがジョブに優先順位を付けることができるかどうかを指定します。選択しない場合、既定値はfalseになります。詳細については、ジョブのヘルプページを参照してください。
canAssignJobs (ブール型): オプションです。ユーザーがジョブを割り当てることができるかどうかを指定します。選択しない場合、既定値はfalseになります。詳細については、ジョブのヘルプページを参照してください。
canCreateCollections (ブール型): オプションです。ユーザーが新しいコレクションを作成できるかどうかを指定します。選択しない場合、既定値はfalseになります。詳細については、コレクションのヘルプページを参照してください。
isApiEnabled (ブール型): オプションです。ユーザーに対してAPIを有効にするかどうかを指定します。選択しない場合、既定値はfalseになります。
defaultCredentialId (文字列): オプションです。このパラメーターは、ユーザーに既定として割り当てられたワークフローの一意のIDを指します。指定しない場合、既定値は""になります。
isActive (ブール型): オプションです。ユーザーを有効にするか無効にするかを選択します。指定しない場合、既定値はtrueになります。
timeZone (文字列): オプションです。Europe/Kievなどのタイムゾーンを入力します。指定しない場合、既定値は""になります。
リクエストの例: 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=John.Doe@emailexample.com'
ユーザーを無効化
システムでユーザーを無効化するには、POST {baseURL}/v3/users/{id}/deactivate エンドポイントを使用します。
パラメーター
id (文字列): 必須です。ユーザーIDを入力して、そのユーザーを無効にします。
リクエストの例: cURL
curl --location --request POST 'http://localhost/webapi/v3/users/61d57bea3c15317e1a48205b/deactivate' \ --header 'Authorization: Bearer BearerTokenGoesHere'
ユーザーのパスワードをリセットする
特定のユーザーに対して、パスワードをリセットしてリセット用Eメールを送信するには、POST {baseURL}/v3/users/{id}/passwordReset エンドポイントを使用します。
注記
このエンドポイントは、Windows認証とSAML認証が設定されているServerインスタンスには使用できません。
パラメーター
id (文字列): 必須です。ユーザーIDを入力してパスワードをリセットします。
リクエストの例: cURL
curl --location --request POST 'http://localhost/webapi/v3/users/61d57bea3c15317e1a48205b/passwordReset' \ --header 'Authorization: Bearer BearerTokenGoesHere'
ユーザーを検索する
ユーザーを検索するには、GET {baseURL}/v3/users エンドポイントを使用します。ユーザーを検索するためのフィルターとしてさまざまなパラメーターを使用します。
パラメーター
view (文字列): オプションです。値を指定しないこともできます。値は「Default」(既定)と「Full」(完全)から選択できます。このパラメーターを「Default」(既定)に設定すると、縮小表示オブジェクトが返されます。指定しない場合は、「Default」(既定)の値が使用されます。
active (ブール型): オプションです。ユーザーを有効にするか無効にするかを選択します。
email (文字列): オプションです。ユーザーのEメールアドレスを入力します。
role (文字列): オプションです。ユーザーロールを選択して検索を絞り込みます。次のオプションから選択します: 「NoAccess」(アクセス権なし)、「Viewer」(ビューワー)、「Member」(メンバー)、「Artisan」(クリエイター)、「Curator」(管理者)、「Evaluated」(評価済み)。既定(Evaluated)ロールは実行時に評価されます。ロールと権限の詳細については、ユーザーロールと権限のページを参照してください。
firstName (文字列): オプションです。ユーザーの名を入力します。
lastName (文字列): オプションです。ユーザーの姓を入力します。
createdAfter (日付/時刻): オプションです。ユーザーが作成された後の日付と時刻を入力します。日付と時刻を ISO8601形式で入力します。
createdBefore (日付/時刻): オプションです。ユーザーが作成される前の日付と時刻を入力します。日付と時刻を 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} エンドポイントを使用します。
パラメーター
id (文字列): 必須です。ユーザーIDを入力して、そのユーザーに関する情報を取得します。
リクエストの例: cURL
curl --location --request GET 'http://localhost/webapi/v3/users/61d57bea3c15317e1a48205b' \ --header 'Authorization: Bearer BearerTokenGoesHere'
ユーザーが所有するすべてのアセットを取得する
ユーザーが所有するすべてのアセットの一覧を取得するには、GET {baseURL}/v3/users/{id}/assets エンドポイントを使用します。
パラメーター
id (文字列): 必須です。ユーザーIDを入力して、そのユーザーのアセットの一覧を取得します。
assetType (文字列): オプションです。返すアセットタイプを選択します。既定値は「All」に設定されています。
リクエストの例: cURL
curl --location --request GET 'http://localhost/webapi/v3/users/61d564361d6d5da7ad461a32/assets?assetType=Workflows' \ --header 'Authorization: Bearer BearerTokenGoesHere'
既存のユーザーを更新する
既存のユーザーを更新するには、 PUT {baseURL}/v3/users/{id} エンドポイントを使用します。
注記
updateContractのIDは、URLのID値で上書きされます。
パラメーター
id (文字列): 必須です。ユーザーIDを入力して、そのユーザーを更新します。
updateContract (本文): 必須です。ユーザーを更新するには、updateContractパラメーターが必要です。次の項目を指定します。
id (文字列): オプションです。ユーザーIDを入力して更新します。
firstName (文字列): 必須です。ユーザーの名を入力します。
lastName (文字列): 必須です。ユーザーの姓を入力します。
email (文字列): 必須です。ユーザーのEメールアドレスを入力します。
role (文字列): 必須です。次のオプションから選択できます: 「NoAccess」(アクセス権なし)、「Viewer」(ビューワー)、「Member」(メンバー)、「Artisan」(クリエイター)、「Curator」(管理者)、「Evaluated」(評価済み)。ロールと権限の詳細については、ユーザーロールと権限のページを参照してください。
defaultWorkerTag (文字列): 必須です。ワーカーで定義されたワーカータグを指定して、特定のワーカーノードにジョブを割り当てる際に役立てることができます。ワーカーの詳細については、ワーカーのヘルプページを参照してください。
canScheduleJobs (ブール型): 必須です。ユーザーがジョブをスケジュールできるかどうかを指定します。詳細については、ジョブのヘルプページを参照してください。
canPrioritizeJobs (ブール型): 必須です。ユーザーがジョブに優先順位を付けることができるかどうかを指定します。詳細については、ジョブのヘルプページを参照してください。
canAssignJobs (ブール型): 必須です。ユーザーがジョブを割り当てることができるかどうかを指定します。詳細については、ジョブのヘルプページを参照してください。
canCreateCollections (ブール型): オプションです。ユーザーがコレクションを作成できるかどうかを指定します。指定しない場合、それまでと同じ値が使用されます。詳細については、コレクションのヘルプページを参照してください。
isApiEnabled (ブール型): 必須です。ユーザーに対してAPIを有効にするかどうかを指定します。
defaultCredentialId (文字列): 必須です。このパラメーターは、ユーザーに既定として割り当てられたワークフローの一意のIDを指します。
isAccountLocked (ブール型): 必須です。このユーザーアカウントをロックするかどうかを選択します。
isActive (ブール型): 必須です。ユーザーを有効にするか無効にするかを選択します。
isValidated (ブール型): 必須です。ユーザーのEメールアドレスを検証するかどうかを指定します。
timeZone (文字列): 必須です。Europe/Kievなどのタイムゾーンを入力します。
language (文字列): 必須です。サポートされている言語の値は、「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 'lastName=Jane' \ --data-urlencode 'email=jdoe@alteryx.com' \ --data-urlencode 'role=Artisan' \ --data-urlencode 'defaultWorkerTag=worker' \ --data-urlencode 'canScheduleJobs=true' \ --data-urlencode 'canPrioritizeJobs=true' \ --data-urlencode 'canAssignJobs=true' \ --data-urlencode 'canCreateCollections=true' \ --data-urlencode 'isApiEnabled=true' \ --data-urlencode 'defaultCredentialId=jdoe' \ --data-urlencode 'isAccountLocked=true' \ --data-urlencode 'isActive=true' \ --data-urlencode 'isValidated=true' \ --data-urlencode 'timeZone=Europe/Prague' \ --data-urlencode 'language=en-us' \ --data-urlencode 'id=61d564361d6d5da7ad461a32'
ユーザーを削除する
特定のユーザーをシステムから削除するには、DELETE {baseURL}/v3/users/{id} エンドポイントを使用します。
注記
削除するユーザーにアセット(ワークフロー、スケジュール、コレクション、インサイト)またはユーザーグループが割り当てられている場合、このユーザーは削除できません。
パラメーター
id (文字列): 必須です。削除するユーザーIDを入力します。
リクエストの例: cURL
curl --location --request DELETE 'http://localhost/webapi/v3/users/61d57bea3c15317e1a48205b' \ --header 'Authorization: Bearer BearerTokenGoesHere'
オブジェクト関係
ユーザーを作成する場合、作成したオブジェクトを次のように使用できます。
作成されたオブジェクト: "id" (例えば、"id": "619158e57e607d0011ac3009")
次のように使用できます。
ユーザーグループにユーザーを追加する場合、userIdとして。
ユーザーグループからユーザーを削除する場合、userIdとして。
特定のユーザーを検索する場合、idとして。
ワークフローをアップロードする場合、ownerIdとして。
コレクションからユーザーを追加する場合、userIdとして。
コレクションからユーザーを削除する場合、userIdとして。
コレクションのユーザー権限を更新する場合、userIdとして。
スケジュールを検索する場合、ownerIdとして。
ユーザーと資格情報を共有する場合、userIdとして。
ユーザーを資格情報から削除する場合、userIdとして。
ユーザーを既存のデータ接続に追加する場合、userIdとして。
ユーザーを既存のデータ接続から削除する場合、userIdとして。
Postmanリクエストの例
GET /v3/users
GET /v3/users/{id}/assets
Postmanリクエストの詳細については、Postmanの使用方法のヘルプページを参照してください。