新規ユーザーの追加
Catalystアプリケーションにエンドユーザーを追加できます。組織が明示的に指定されていない場合、ユーザーはデフォルトの組織に自動的に割り当てられます。ユーザーが追加されると、Catalystによって一意のuser_IDとZUIDが生成されます。
ディクショナリの作成
Catalystアプリケーションに新しいユーザーを追加する前に、ユーザーの姓、割り当てるロール、メールアドレス、アプリケーションプラットフォーム、現在の作業環境に基づくZAIDデータなどのユーザー詳細を含むディクショナリを作成する必要があります。これらの詳細を含むディクショナリは、register_user()メソッドにパラメータとして渡されます。
- ユーザーを登録するには、email_idとfirst_nameの値を必ず指定する必要があります。
- role_idは、Catalystコンソールの_Authentication_の_Roles_セクションから取得できます。
- ZAIDは、Catalystコンソールの環境設定から取得できます。
- 新しいユーザーを招待する際に、送信者のメールアドレス、件名、メールメッセージを設定できます。SDKコードで使用する前に、Catalyst Mailコンポーネントでメールアドレスを追加し、認証を完了させる必要があります。
#辞書を作成する
signup_config = {
"platform_type": "web",
"zaid": "81008807534807534",
"template_details": {
"senders_mail": "dogogetu@tutuapp.bid",
"subject": "Welcome to %APP_NAME%",
"message": "<p>Hello ,</p> <p>Follow this link to join in %APP_NAME% .</p> <p><a href='%LINK%'>%LINK%</a></p> <p>If you didn't ask to join the application, you can ignore this email.</p> <p>Thanks,</p> <p>Your %APP_NAME% team</p>",
},
}
user_details = {
"first_name": "Amelia",
"last_name": "Burrows",
"role_id": "1008807534",
"email_id": "amelia.burrows@zylker.com",
}
新規ユーザーの追加
ディクショナリに必要なユーザー情報を設定した後、組織に新しいユーザーを追加できます。この場合、組織はユーザーに自動的に割り当てられます。
register_user()メソッドはユーザー作成プロセスを処理し、レスポンスを返します。以下で使用されているコンポーネントインスタンスauthentication_serviceの詳細については、こちらのセクションを参照してください。
使用するパラメータ
| パラメータ名 | データ型 | 定義 |
|---|---|---|
| signup_config | Object | 必須パラメータです。アプリケーションプラットフォーム、ZAID、登録後に送信するメール情報を含むユーザー登録の詳細を格納します。 |
| user_details | Object | 必須パラメータです。名、姓、メールID、ユーザーを追加する組織のIDなどのユーザー登録詳細を保持します。 |
#新しいユーザーを追加する
authentication_service = app.authentication()
response_data = authentication_service.register_user(signup_config, user_details)
サンプルレスポンスを以下に示します：
{
"zaid":"81008807534807534",
"user_details":{
"zuid":"1005641290",
"org_id":"1005641456",
"status":"ACTIVE",
"is_confirmed":false,
"email_id":"amelia.burrows@zylker.com",
"first_name":"Amelia",
"last_name":"Burrows",
"created_time":"Aug 12, 2021 12:33 PM",
"modified_time":"Aug 12, 2021 12:33 PM",
"invited_time":"Aug 12, 2021 12:33 PM",
"role_details":{
"role_name":"App User",
"role_id":"2305000000006024"
},
"user_type":"App User",
"user_id":"2305000000007752",
"project_profiles":[
]
},
“redirect_url”:“https://aliencity-66446133.development.catalystserverless.com/app/",
“platform_type”:“web”,
“org_id”:“1005641456”
}
最終更新日 2026-03-30 13:40:30 +0530 IST
Yes
No
Thank you for your feedback!
Send your feedback to us