ユーザーの更新

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

注

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

オプション

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

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

ドロップダウンFALSE

入力

フィールド定義タイプ必須
ユーザー
IDOktaユーザーのID (通常はメール形式)。文字列FALSE
Option (オプション)
Pass Empty Values? (空の値の受け渡し?) [Update Semantics (セマンティクスの更新)]Partialに設定される場合にのみ表示されます。
  • Yesの場合、選択されて有効な値が入力されているすべてのフィールドが更新されます。選択されているが空白のままのすべてのフィールドは、特殊なフィールドを除きクリアされます。下記の注を参照してください。選択されていないすべてのフィールドは変更されずに残ります。
  • Noの場合、選択されて有効な値が入力されているすべてのフィールドが更新されます。選択されていないか空白のままのすべてのフィールドは変更されずに残ります。
  • 」も参照してください。
ドロップダウンFALSE
プロファイル
City (市)ユーザーの住所の市部分。文字列FALSE
Cost center (コストセンター)ユーザーに割り当てられているコストセンターの名前。文字列FALSE
Country code (国コード)国の省略形。文字列FALSE
Department (部門)ユーザーの所属部署の名前。文字列FALSE
Display name (表示名)ユーザーの名前。エンドユーザーへの表示に適しています。文字列FALSE
Division (部門)ユーザーの事業部の名前。文字列FALSE
Primary email (プライマリーメール)ユーザーのプライマリーメールアドレス。文字列FALSE
Employee number (従業員番号)組織または企業からユーザーに割り当てられている一意の識別子。文字列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)ユーザーのオンラインプロファイル (ウェブページ) の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
Credentials (資格情報)
パスワードユーザーの新規パスワードの文字列値。文字列FALSE
Recovery Question (復旧質問)ユーザーのパスワード復旧を可能にするための質問。文字列FALSE
Recovery Answer (復旧回答)パスワード復旧質問に対する回答。文字列FALSE
」も参照してください。

出力

フィールド定義タイプ
System Properties (システムプロパティー)
IDOktaユーザーのID。文字列
Status (ステータス)ユーザーの現在のステータスで、STAGEDPROVISIONEDACTIVERECOVERYLOCKED_OUTPASSWORD_EXPIREDSUSPENDEDDEPROVISIONEDのいずれか。文字列
Created(作成日時)

オブジェクトが作成された日時。

日付&時刻
Activated (アクティベート)ACTIVEステータスへの遷移が完了した時点のタイムスタンプ。ブーリアン
Status Changed (ステータス変更日時)ユーザーのステータスが最後に変更された日。日付&時刻
Last Login (最終ログイン日時)ユーザーの最終ログイン日時のタイムスタンプ。日付&時刻
Last Updated (最終更新日時)ユーザーの最終更新日時のタイムスタンプ。日付&時刻
Password Changed (パスワード変更日時)ユーザーのパスワードが最後に変更された時点のタイムスタンプ。ブーリアン
Credentials (資格情報)
Emails (メール)ユーザーに関連付けられたメールのリスト。リスト
Password (パスワード) ユーザーが有効なパスワードを持っているかハッシュパスワードをインポートした場合はtrue。それ以外の場合はfalseブーリアン
Recovery Question (復旧質問)ユーザーがパスワードを忘れた場合の復旧質問。文字列
Provider (プロバイダー)
Name (名前)認証プロバイダーの名前。文字列
タイプ認証プロバイダーのタイプ。OKTAACTIVE_DIRECTORYLDAPFEDERATIONSOCIAL、またはIMPORT文字列
Profile Properties (プロファイルプロパティー)
City (市)ユーザーの住所の市部分。文字列
Cost center (コストセンター)ユーザーに割り当てられているコストセンターの名前。文字列
Country code (国コード)国の省略形。文字列
Department (部門)ユーザーの所属部署の名前。文字列
Display name (表示名)ユーザーの名前。エンドユーザーへの表示に適しています。文字列
Division (部門)ユーザーの事業部の名前。文字列
Primary email (プライマリーメール)ユーザーのプライマリーメールアドレス。文字列
Employee number (従業員番号)組織または企業からユーザーに割り当てられている一意の識別子。文字列
First name (名)ユーザーの名。文字列
Honorific prefix (敬称接頭辞)ユーザーの敬称接頭辞。ほとんどの西洋言語では称号としても知られています。文字列
Honorific suffix (敬称接尾辞)ユーザーの敬称接尾辞。ほとんどの西洋言語では称号としても知られています。文字列
Last name (姓)ユーザーの姓つまり名字。文字列
Locale (ロケール)通貨、日時の形式、数値の表示形式などの項目をローカライズするための、ユーザーのデフォルトの場所。文字列
Username (ユーザー名)ユーザーのログインユーザー名 (通常、メールアドレスの形式)。文字列
Manager (マネージャー)ユーザーのマネージャーの表示名。文字列
ManagerId (マネージャーID)ユーザーのマネージャーのID。文字列
Middle name (ミドルネーム)ユーザーのミドルネーム。文字列
Mobile phone (携帯電話)ユーザーの携帯電話番号。文字列
Nickname (ニックネーム)ユーザーが選定するニックネーム (該当する場合)。文字列
組織ユーザーの組織の名前。文字列
Postal Address (郵便物送付先)ユーザーの住所の郵便物送付先部分文字列
Preferred language (優先言語)ユーザーの優先する書き言葉または話し言葉の言語。文字列
Primary phone (メインの電話番号)ユーザーのメインの電話番号 (自宅の番号など)。文字列
Profile Url (プロファイルURL)ユーザーのオンラインプロファイル (ウェブページ) の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 (プライマリーメール)
セマンティクスの更新の設定空の値の受け渡しの設定基本フィールドの処理
PartialYes
  • これら4つのフィールドのいずれかが選択されて空白のままの場合、カードはエラーを報告します。
  • これらのフィールドのいずれかが選択されて有効な値が入力されている場合、更新されます。
  • 選択されていないすべてのフィールドは変更されずに残ります。
PartialNo
  • これら4つのフィールドのいずれかが選択されて有効な値が入力されている場合、更新されます。
  • これらのフィールドのいずれかが選択されているが空白のままか選択されていない場合、変更されずに残ります。
StrictN/A
  • これら4つのフィールドのいずれかが選択されているが空白のままか選択されていない場合、カードはエラーを報告します。
  • これらすべてのフィールドが選択されて有効な値が入力されている場合にのみ、カードは通過できます。

2. 資格情報

a. パスワード

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

b. 復旧質問と復旧回答

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

関連項目

Oktaコネクタ

Okta Workflowsの要素について

Okta API