ユーザーの更新

IDまたはユーザー名によって、Oktaユーザーのシステム情報およびプロファイルプロパティを更新します。

このアクションは、アプリケーションユーザーについての情報を更新しません。ユーザーのタイプが無効または正しくないとき、この操作を試みると、404エラーが返されます。アプリケーションユーザーに関する詳細を取得するには、Custom API Actionカードを使用します。アプリケーション用に割り当てられているユーザーに関する情報の参照の詳細については、「アプリケーションユーザーの処理」を参照してください。

スコープ

このカードで必要なOAuthスコープのリストは「アクションカード」を参照してください。

オプション

フィールド	定義	タイプ	Required (必須)
Update Semantics (セマンティクスの更新)	Partial：部分的な更新セマンティクスを使用してユーザーのプロファイルまたは資格情報を更新します。指定されないすべてのプロパティーは無視され、現在の値を維持します。 Strict：厳格な更新セマンティクスを使用してユーザーのプロファイルおよび資格情報を更新します。IMPORTANT（重要）：ユーザーのプロファイルを更新する際、すべてのプロファイルを指定する必要があります。リクエストで指定されないすべてのプロパティーはnullに設定されます。	ドロップダウン	FALSE

フィールド

定義

タイプ

Required (必須)

Update Semantics (セマンティクスの更新)

Partial：部分的な更新セマンティクスを使用してユーザーのプロファイルまたは資格情報を更新します。指定されないすべてのプロパティーは無視され、現在の値を維持します。

Strict：厳格な更新セマンティクスを使用してユーザーのプロファイルおよび資格情報を更新します。IMPORTANT（重要）：ユーザーのプロファイルを更新する際、すべてのプロファイルを指定する必要があります。リクエストで指定されないすべてのプロパティーはnullに設定されます。

FALSE

入力

フィールド	定義	タイプ	必須
User（ユーザー）
ID	OktaユーザーのID（通常はメール形式）。	テキスト	FALSE
オプション
Pass Empty Values? (空の値の受け渡し？)	［Update Semantics（セマンティクスの更新）］がPartialに設定される場合にのみ表示されます。 Yesの場合、選択されて有効な値が入力されているすべてのフィールドが更新されます。選択されているが空白のままのすべてのフィールドは、特殊なフィールドを除きクリアされます。下記の注を参照してください。選択されていないすべてのフィールドは変更されずに残ります。 Noの場合、選択されて有効な値が入力されているすべてのフィールドが更新されます。選択されていないか空白のままのすべてのフィールドは変更されずに残ります。「1. 基本情報フィールド」も参照してください。	ドロップダウン	FALSE
プロファイル
City（市区町村）	ユーザーの住所の市部分。	テキスト	FALSE
Cost Center（コストセンター）	ユーザーに割り当てられているコストセンターの名前。	テキスト	FALSE
Country Code (国番号)	国の省略形。	テキスト	FALSE
Department（部署）	ユーザーの所属部署の名前。	テキスト	FALSE
Display name（表示名）	ユーザーの名前。エンドユーザーへの表示に適しています。	テキスト	FALSE
Division (部門)	ユーザーの事業部の名前。	テキスト	FALSE
Primary Email (プライマリメールアドレス)	ユーザーのプライマリメールアドレス。	テキスト	FALSE
Employee number（従業員番号）	Organizationまたは企業からユーザーに割り当てられている一意の識別子。	テキスト	FALSE
First name（名）	ユーザーの名。	テキスト	FALSE
Honorific prefix（敬称接頭辞）	ユーザーの敬称接頭辞。ほとんどの西洋言語では称号としても知られています。	テキスト	FALSE
Honorific suffix（敬称接尾辞）	ユーザーの敬称接尾辞。ほとんどの西洋言語では称号としても知られています。	テキスト	FALSE
Last name（姓）	ユーザーの姓つまり名字。	テキスト	FALSE
Locale（ロケール）	通貨、日時の形式、数値の表示形式などの項目をローカライズするための、ユーザーのデフォルトの場所。	テキスト	FALSE
Username（ユーザー名）	ユーザーのログインユーザー名（通常、メールアドレスの形式）。	テキスト	FALSE
Manager（マネージャー）	ユーザーのマネージャーの表示名。	テキスト	FALSE
ManagerId (マネージャーID)	ユーザーのマネージャーのID。	テキスト	FALSE
Middle name（ミドルネーム）	ユーザーのミドルネーム。	テキスト	FALSE
Mobile phone (携帯電話)	ユーザーの携帯電話番号。	テキスト	FALSE
Nickname（ニックネーム）	ユーザーが選定するニックネーム（該当する場合）。	テキスト	FALSE
Organization（組織）	ユーザーの組織の名前。	テキスト	FALSE
Postal Address（郵便物送付先）	ユーザーの住所の郵便物送付先部分。	テキスト	FALSE
Preferred language（優先言語）	ユーザーの優先する書き言葉または話し言葉の言語。	テキスト	FALSE
Primary phone（メインの電話番号）	ユーザーのメインの電話番号（自宅の番号など）。	テキスト	FALSE
Profile Url（プロファイルURL）	ユーザーのオンラインプロファイル（Webページ）のURL。	テキスト	FALSE
Secondary email（セカンダリメールアドレス）	ユーザーのセカンダリメールアドレス（一般にアカウント復旧に使用）。	テキスト	FALSE
State（状態）	ユーザーの住所の州または地域部分。	テキスト	FALSE
Street address（番地）	ユーザーの住所の完全な番地部分。	テキスト	FALSE
Time zone (タイムゾーン)	ユーザーのタイムゾーン。	テキスト	FALSE
Title（タイトル）	ユーザーの役職名。	テキスト	FALSE
User type（ユーザータイプ）	組織に対するユーザーの関係（従業員または請負業者など）。	テキスト	FALSE
Zip code（郵便番号）	ユーザーの住所のZIPコードまたは郵便番号部分。	テキスト	FALSE
Custom Profile Properties (カスタムプロファイルプロパティー)	このカードの設定時に生成される追加のカスタムユーザープロファイルプロパティー。	動的生成	FALSE
資格情報
Password（パスワード）	ユーザーの新規パスワードの文字列値。	テキスト	FALSE
Recovery Question（復旧質問）	ユーザーのパスワード復旧を可能にするための質問。	テキスト	FALSE
Recovery Answer（復旧回答）	パスワード復旧質問に対する回答。	テキスト	FALSE
「2. 資格情報」も参照してください。

出力

フィールド	定義	Type（タイプ）
システムプロパティ
ID	OktaユーザーのID。	テキスト
Status（ステータス）	ユーザーの現在のステータスで、STAGED、PROVISIONED、ACTIVE、RECOVERY、LOCKED_OUT、PASSWORD_EXPIRED、SUSPENDED、DEPROVISIONEDのいずれか。	テキスト
Created（作成日時）	オブジェクトが作成された日時。	日時
Activated（アクティブ化）	ACTIVEステータスへの遷移が完了した時点のタイムスタンプ。	True/False
Status Changed（ステータス変更日時）	ユーザーのステータスが最後に変更された日。	日時
Last Login（前回のログイン）	ユーザーの最終ログイン日時のタイムスタンプ。	日時
Last Updated（最終更新日時）	ユーザーの最終更新日時のタイムスタンプ。	日時
Password Changed（パスワード変更日時）	ユーザーの最終パスワード変更日時のタイムスタンプ。	True/False
Credentials（資格情報）
Emails（メール）	ユーザーに関連付けられたメールのリスト。	リスト
Password（パスワード）	ユーザーが有効なパスワードを持っているかハッシュパスワードをインポートした場合はtrue。それ以外の場合はfalse。	True/False
Recovery Question（復旧質問）	ユーザーがパスワードを忘れた場合の復旧質問。	テキスト
Provider（プロバイダー）
Name（名前）	認証プロバイダーの名前。	テキスト
Type（タイプ）	認証プロバイダーのタイプ。OKTA、ACTIVE_DIRECTORY、LDAP、FEDERATION、SOCIAL、またはIMPORT。	テキスト
プロファイルプロパティ
City（市区町村）	ユーザーの住所の市部分。	テキスト
Cost Center（コストセンター）	ユーザーに割り当てられているコストセンターの名前。	テキスト
Country Code（国番号）	国の省略形。	テキスト
Department（部署）	ユーザーの所属部署の名前。	テキスト
Display name（表示名）	ユーザーの名前。エンドユーザーへの表示に適しています。	テキスト
Division（事業部）	ユーザーの事業部の名前。	テキスト
Primary Email (プライマリメールアドレス)	ユーザーのプライマリメールアドレス。	テキスト
Employee number（従業員番号）	Organizationまたは企業からユーザーに割り当てられている一意の識別子。	テキスト
First name（名）	ユーザーの名。	テキスト
Honorific prefix（敬称接頭辞）	ユーザーの敬称接頭辞。ほとんどの西洋言語では称号としても知られています。	テキスト
Honorific suffix（敬称接尾辞）	ユーザーの敬称接尾辞。ほとんどの西洋言語では称号としても知られています。	テキスト
Last name（姓）	ユーザーの姓つまり名字。	テキスト
Locale（ロケール）	通貨、日時の形式、数値の表示形式などの項目をローカライズするための、ユーザーのデフォルトの場所。	テキスト
Username（ユーザー名）	ユーザーのログインユーザー名（通常、メールアドレスの形式）。	テキスト
Manager（マネージャー）	ユーザーのマネージャーの表示名。	テキスト
ManagerId（マネージャーID）	ユーザーのマネージャーのID。	テキスト
Middle name（ミドルネーム）	ユーザーのミドルネーム。	テキスト
Mobile phone（携帯電話）	ユーザーの携帯電話番号。	テキスト
Nickname（ニックネーム）	ユーザーが選定するニックネーム（該当する場合）。	テキスト
Organization（組織）	ユーザーの組織の名前。	テキスト
Postal Address（郵便物送付先）	ユーザーの住所の郵便物送付先部分。	テキスト
Preferred language（優先言語）	ユーザーの優先する書き言葉または話し言葉の言語。	テキスト
Primary phone（メインの電話番号）	ユーザーのメインの電話番号（自宅の番号など）。	テキスト
Profile Url（プロファイルURL）	ユーザーのオンラインプロファイル（Webページ）のURL。	テキスト
Secondary email（セカンダリメールアドレス）	ユーザーのセカンダリメールアドレス（一般にアカウント復旧に使用）。	テキスト
State（状態）	ユーザーの住所の州または地域部分。	テキスト
Street address（番地）	ユーザーの住所の完全な番地部分。	テキスト
Time zone（タイムゾーン）	ユーザーのタイムゾーン。	テキスト
Title（役職）	ユーザーの役職名。	テキスト
User type（ユーザータイプ）	組織に対するユーザーの関係（従業員または請負業者など）。	テキスト
Zip code（郵便番号）	ユーザーの住所のZIPコードまたは郵便番号部分。	テキスト
Custom Profile Properties（カスタムプロファイルプロパティ）	このカードの設定時に生成される追加のカスタムユーザープロファイルプロパティー。	動的生成

追加情報

1. 基本情報フィールド

次の4つのフィールドは基本情報フィールドで、クリアできません。

Username（ユーザー名）
First Name（名）
Last Name（姓）
Primary Email (プライマリメールアドレス)

セマンティクスの更新の設定	空の値の受け渡しの設定	基本フィールドの処理
Partial	はい	これら4つのフィールドのいずれかが選択されて空白のままの場合、カードはエラーを報告します。これらのフィールドのいずれかが選択されて有効な値が入力されている場合、更新されます。選択されていないすべてのフィールドは変更されずに残ります。
Partial	No	これら4つのフィールドのいずれかが選択されて有効な値が入力されている場合、更新されます。これらのフィールドのいずれかが選択されているが空白のままか選択されていない場合、変更されずに残ります。
Strict	N/A	これら4つのフィールドのいずれかが選択されているが空白のままか選択されていない場合、カードはエラーを報告します。これらすべてのフィールドが選択されて有効な値が入力されている場合にのみ、カードは通過できます。

セマンティクスの更新の設定

空の値の受け渡しの設定

基本フィールドの処理

Partial

はい

これら4つのフィールドのいずれかが選択されて空白のままの場合、カードはエラーを報告します。
これらのフィールドのいずれかが選択されて有効な値が入力されている場合、更新されます。
選択されていないすべてのフィールドは変更されずに残ります。

Partial

これら4つのフィールドのいずれかが選択されて有効な値が入力されている場合、更新されます。
これらのフィールドのいずれかが選択されているが空白のままか選択されていない場合、変更されずに残ります。

Strict

N/A

これら4つのフィールドのいずれかが選択されているが空白のままか選択されていない場合、カードはエラーを報告します。
これらすべてのフィールドが選択されて有効な値が入力されている場合にのみ、カードは通過できます。

2. 資格情報

a. Password（パスワード）

実際の値を表示しませんが、フィールドが既存の値を含むか値がクリアされているかどうかにかかわらず常にtrueを表示します。
ユーザーが資格情報なしで作成され、以前に有効なパスワードが設定されたことがない場合にのみfalseを表示します。
フィールドをクリアするには、フィールドを選択し、空白のままにした状態で、次のいずれかのオプションを使用します。
- ［Update Semantics（セマンティクスの更新）］をPartialに設定し、［Pass Empty Values（空の値の受け渡し）］をYesに設定する
- ［Update Semantics（セマンティクスの更新）］をStrictに設定する
フィールドが選択されていない場合、常に変更されずに残ります。

b. 復旧質問と復旧回答

これらのフィールドを消去することはできません。
ユーザーが資格情報なしで作成され、以前に有効な復旧質問と復旧回答が設定されたことがない場合にのみ空にすることができます。
これら2つのフィールドは同時に更新する必要があり、そうしない場合は変更されずに残ります。