updateUser

カテゴリ	メタデータの変更
説明	ユーザーを更新する。成功した場合、API は更新されたユーザーに対してメッセージを返します。
起動に必要な権限	ユーザー権限
リクエストに応じてパラメータが必要	認証情報

このメソッドのリクエストには、呼び出し元のユーザーを識別し、認証するための認証情報タグが含まれています。ユーザーを更新するには、"ユーザー権限" 権限が必要です。

この方法では、ユーザーの概念: アクセスルール (属性アクセス制御)

この方法は、Workday からのユーザー同期の後には機能しません。これは、ユーザーの同期が発生する 前に、
権限セットと組織アクセスの割り当てのみを許可するものです。

リクエストのフォーマット


<?xml version='1.0' encoding='UTF-8'?>
<call method="updateUser" callerName="a string that identifies your client application">
     <credentials login="sampleuser@company.com" password="my_pwd" />
       <users>
           <user
             guid="B9ADBCB81AA2F9BAE040307F02092C2E"
             email="updateMail@company.com"
             name="update name"
             password="new Password"
             alternateEmail="abc@greenco.com"
             samlFedId="1234"
             permissionSetId="1"
             ownedLevels="2,3,7,11"
             timeZone="America/Mexico_City"
                  />
      </users>
</call>

認証情報要素
タグ名		認証情報
説明		すべての API 呼び出しには、API を呼び出したユーザーを識別するための単一の認証情報要素が含まれている必要があります。その後、この API 呼び出しはこのユーザーとして実行されます (システムの監査証跡やアクション履歴は、このユーザーがアクションを実行したことを示します)。そのため、API 呼び出しが成功:
要素の特性
特性名	必須？	値	例
ログイン	あり	API メソッドを呼び出すユーザーのログイン名。このユーザーは、メソッドを呼び出すために必要な権限を持っている必要があります	sampleuser@company.com
password	あり	API メソッドを呼び出すユーザーのパスワード。	my_password
ロケール	なし	入力される数値と日付の解釈、および出力する数値と日付の形式設定 (適切な千単位の区切り文字、月名、日付の形式設定を使用) に使用されるロケールを指定します。ロケールは、応答内のシステムメッセージを表示する言語を指定するためにも使用されます。指定しない場合は、en_US (米国英語) が使用されます。	fr_FR
instanceCode	なし	認証情報で指定されたユーザーがの複数のインスタンスにアクセスできる場合、 Adaptive Planning 、この属性は、ユーザーがデフォルトのインスタンス以外のインスタンスにアクセスしようとしていることを指定するのに使用できます。指定しない場合、ユーザーのデフォルトのインスタンスが使用されます。使用可能なインスタンスコードを決定するには、exportInstances API を使用します。	MYINSTANCE1
エレメントの内容
(なし)

ユーザー要素
タグ名		ユーザー
説明		更新するユーザー (複数可) を指定します。
要素の特性
特性名	必須？	値	例
ガイド	あり	ユーザーのグローバルに一意の識別子。この識別子は、将来ログインまたは名前が変更されても変更されることはありません。(ガイドは exportUsers API に含まれます)	B9ADBCB81AA2F9BAE040307F02092C2E
E メール	なし	このユーザーの E メールアドレス。一意性が必要です。使用できる文字は、a、z、0 ～ 9、-、およびのみです。この E メールアドレスはユーザー名を示します。	newUser@company.com
名前	なし	このユーザーの名前。	メルビンムルメール
ポジション API v39 以上で使用可能	なし	ユーザーのポジション	"CEO"
password	なし	このユーザーのパスワード。マルチインスタンス環境のユーザーを更新する場合、パスワードの変更はデフォルトのインスタンスでしか指定できません。	newpassword
alternateEmail API v27 で使用可能	なし	このユーザーの代替 E メールアドレス。このオプションは自動的にオンになり、"ユーザー詳細" セクションにユーザーの E メール ID が入力されます。	abc@greenco.com
samlFedId API v27 で使用可能	なし	このユーザーの SAML フェデレーション ID。	1234, user@company.com
permissionSetId API v25 以上で使用可能	なし	このユーザーに割り当てられた権限セットの内部システム ID。	3
roleId API v25 以前で使用可能 API v25+ では使用できません。	なし	このユーザーに割り当てられたロールの内部システム ID。(roleId 特性は exportRoles API でカバーされます。)	3
ownedLevels	なし	カンマで区切られた組織の内部システム ID。(ownLevels 特性は exportLevels API でカバーされます。)	5,10,13
ホームページ API v39 以上で使用可能	なし	ユーザーのホームページ。	"Welcome"
timeZone	なし	ユーザーのタイムゾーン。	米国/太平洋地域
国 API v39 以上で使用可能	なし	ユーザーの国コード (英 2 文字コード)。	"US"
usState API v39 以上で使用可能	なし	ユーザーの状態コード (国は米国である必要があります)。	"CA"
エリア API v39 以上で使用可能	なし	ユーザーのエリア ID	"111"
ダッシュボード API v39 以上で使用可能	なし	ユーザーのダッシュボード ID - ダッシュボード ID を設定するにはエリア ID が必要です。エリア ID が指定され、ダッシュボード ID が指定されていない場合、ダッシュボード ID はヌルに設定されます。	"222"
netsuiteLogin API v39 以上で使用可能	なし	NetSuite ログイン	"abc@netsuite.com"
salesforceLogin API v39 以上で使用可能	なし	Salesforce ログイン	"abc@salesforce.com"
エレメントの内容
(なし)

回答フォーマット


<?xml version='1.0' encoding='UTF-8'?>
 <response success="true">
    <output>
        <result>
              <updated_users>
                  <user success="true" message="user newUser@company.com was updated successfully."/>
              </updated_users>
        </result>
    </output>
</response>

回答エレメント
タグ名		response
要素の特性
特性名	必須？	値	例
成功	あり	真偽のいずれか。API 呼び出しが成功したかどうかを示します。呼び出しが成功した場合でも、応答に警告メッセージが含まれる場合があります。	真
エレメントの内容
createUser または updateUser の呼び出しがそれぞれ行われたかどうかに応じて、 created_user または updateUser のステータス要素を含む単一の結果要素

結果要素
タグ名		result
説明		1 つ以上のステータス要素のコンテナです。
要素の特性
特性名	必須？	値	例
(なし)
エレメントの内容
1 つ以上の created_user または updateUser の呼び出しがそれぞれ行われたかどうかに応じて、1 つ以上の created_user または update_user ステータス要素を入力します。

update_users 要素
タグ名		updated_users
説明		システムから呼び出し元に送り返されるメッセージを表します。
要素の特性
特性名	必須？	値	例
ユーザー成功	あり	呼び出しによって返されたステータス真でも偽でも構いません。	真
message	あり	ステータスメッセージ。	ユーザーnewuser@company.com が更新されました。
エレメントの内容
1 つのサブスクリプションエレメント