プロファイル登録フォームの属性のルールを理解する

プロファイル登録フォームを扱うときは、フォームによって継承されるOkta Universal Directory(UD)属性の要件とユーザー許可の設定を理解する必要があります。

プログレッシブ登録シナリオでのプロファイル登録フォームの目的は、エンドユーザーに関する情報を収集し、Oktaユーザープロファイルに追加することです。そのため、エンドユーザーに表示される属性は、UDのデフォルトのユーザープロファイルですでに定義されている必要があります。

基準属性

Oktaのデフォルトのユーザープロファイルには、31の定義済み属性があります。「プロファイルタイプ」を参照してください。これらの基準属性はいずれもプロファイル登録フォームに追加できますが、次のルールに従う必要があります。

  • プロファイル登録フォームで使用するUD属性には、[Read-Write(読み取り-書き込み)][User permission(ユーザー許可)]設定が必要です。これは、サインインプロセス中にユーザーがこの属性の値を更新できるようにするために必要です。

    • UD属性の[User permission(ユーザー許可)][Hide(非表示)]または[Read Only(読み取り専用)]の場合、登録フォームは無効になります。プロファイルエディターを使って[User permission(ユーザー許可)]のレベルを変更するまで、フォームのどの部分も追加、編集、または削除できません。

  • UDの属性に対して[Attribute required(必須属性)]設定が有効になっている場合、登録ポリシーを作成すると、プロファイル登録フォームにその属性が自動的に追加されます。

    • この属性に対してエンドユーザーに表示される[Form label(フォームラベル)]を編集できます。

    • この属性の[Input requirement(入力要件)]は変更できません。OktaがユーザーのUDプロファイルに値を追加してサインインプロセスを続行できるように、エンドユーザーが値を提供する必要があるため、これは[Required(必須)]に設定されています。

    • プロファイル登録フォームでは、この[Input requirement(入力要件)]フィールドの値が[Requirement(要件)]列に表示されます。

    • [Input display type(入力の表示タイプ)]は変更できません。

    • この属性をフォームから削除することはできません。

  • UDの属性に対して[Attribute required(必須属性)]設定が有効になっていない場合、その属性はフォームに自動的に追加されません。

    • この属性は、後で登録フォームから追加または削除できます。

    • この属性に対してエンドユーザーに表示される[Form label(フォームラベル)]を編集できます。

    • この属性の[Input requirement(入力要件)][Required(必須)]または[Optional(任意)]に変更できます。

      • [Required(必須)]:エンドユーザーがサインインプロセスを続行するには、この入力を行う必要があります。

      • [Optional(任意)]:エンドユーザーは、この入力をスキップしてサインインプロセスを続行できます。

    • プロファイル登録フォームでは、この[Input requirement(入力要件)]フィールドの値が[Requirement(要件)]列に表示されます。

    • この属性はUDプロファイルレベルでは必要ないため、登録フォームから削除できます。

次の表では、いくつかのベースプロファイル属性の例について、必要な条件と許可されるアクションについて説明します。

UD:変数名 UD:属性 PE:フォームへの自動追加 PE:許可されるアクション
user.login はい はい
  • フォームラベルの編集のみ
user.firstName

はい

はい

  • フォームラベルの編集のみ
user.middleName いいえ いいえ
  • 追加
  • フォームラベルの編集
  • 入力要件の編集
  • 削除
user.title いいえ いいえ
  • 追加
  • フォームラベルの編集
  • 入力要件の編集
  • 削除

カスタム属性

カスタム属性は、ベースのOkta UD属性以外の属性です(たとえば、スポーツファンのお気に入りのチームや、薬局の顧客のワクチン接種状況など)。エンドユーザーからデータを収集するカスタム属性は、プロファイル登録フォームに追加する前に、UDプロファイルに追加する必要があります。

カスタム属性は、基準属性と同じ制限に従います。

  • プロファイル登録フォームに追加できるように、UDで属性の[User permission(ユーザー許可)]設定を[Read-Write(読み取り-書き込み)]に設定する必要があります。
  • UDで必須属性としてマークされていれば、プロファイル登録フォームの属性のラベルを編集できますが、属性を削除することはできません。
  • UDでオプションの属性としてマークされていれば、属性のラベルと入力オプション(登録フォームの必須または任意のステップとして指定することを含む)を編集したり、属性を削除したりできます。
  • [Input display type(入力の表示タイプ)]を、エンドユーザーから期待される情報の種類が最も適切に反映される値に変更できます。列挙データ型ではラジオボタンまたはドロップダウンメニューが使用されますが、ほとんどのフィールドは文字列データ型を持ち、入力タイプとしてテキストボックスが使用されます。ただし、国コードやブーリアンなどのデータ型を持つフィールドを選択すると、登録フォームが対応する入力タイプに変更されます。

次の表では、いくつかのカスタムプロファイル属性の例について、必要な条件と許可されるアクションについて説明します。

UD:変数名 UD:属性 PE:フォームへの自動追加 PE:許可されるアクション
favoriteTeam はい はい
  • フォームラベルの編集のみ
favoritePlayer いいえ いいえ
  • 追加
  • フォームラベルの編集
  • 入力要件の編集
  • 入力タイプの編集
  • 削除

複数のID

IDは、ユーザーがアプリへのサインイン時またはアカウントの復旧時にユーザー名の代わりに入力できる属性です。デフォルトのOktaユーザープロファイル内の2つのカスタム属性を選択することで、IDとして機能させることができます。ただし、それらの属性は機密性がなく、データタイプが文字列である必要があります。

IDは、ユーザープロファイルポリシーにアプリ単位ベースで構成されます。IDを有効化するためにUniversal Directoryで実行が必要なことは何もありませんが、この目的で新しい属性を追加するときは、カスタム属性の推奨事項に従います。

関連項目

カスタムプロファイル登録フォームを作成する