ユーザー詳細の取得
Catalyst認証は、アプリケーションユーザーの詳細を取得するためのいくつかのメソッドを提供しています。現在のユーザー、特定のユーザー、またはアプリケーションの全ユーザーのユーザー情報を取得できます。
現在のユーザーの詳細を取得
get_current_user()メソッドは、アプリケーションにアクセスしている現在のユーザー、つまり関数が実行されているスコープのユーザーの詳細を取得します。以下で使用されているコンポーネントインスタンスauthentication_serviceの詳細については、こちらのセクションを参照してください。
#ユーザーの詳細を取得する
authentication_service = app.authentication()
current_user = authentication_service.get_current_user()
サンプルレスポンスを以下に示します：
{
"zuid":"1005641433",
"org_id":"1005641434",
"status":"ACTIVE",
"is_confirmed":false,
"email_id":"amelia.burrows@zylker.com",
"first_name":"Amelia",
"last_name":"Burrows",
"created_time":"Aug 12, 2021 12:27 PM",
"role_details":{
"role_name":"App User",
"role_id":"2305000000006024"
},
"user_type":"App User",
"user_id":"2305000000007745",
"locale":"us|en|Asia/Kolkata",
"time_zone":"Asia/Kolkata",
"project_profiles":[
]
}
User IDによるユーザー詳細の取得
get_user_details()メソッドにユーザーのuserIDを渡すことで、特定のユーザーの詳細を取得できます。レスポンスには、姓、ユーザーが持つロールのリスト、ユーザータイプ、ユーザーが所属する組織のorgID、メールアドレスなど、特定のユーザーの詳細が返されます。
以下で使用されているコンポーネントインスタンスauthentication_serviceの詳細については、こちらのセクションを参照してください。
使用するパラメータ
| パラメータ名 | データ型 | 定義 |
|---|---|---|
| user_id | String | 必須パラメータです。詳細を取得するユーザーの一意のIDを格納します。 |
#ユーザーIDで詳細を取得する
authentication_service = app.authentication()
user_details=authentication_service.get_user_details('12345')
サンプルレスポンスを以下に示します：
{
"zuid":"1005665160",
"org_id":"1005665245",
"status":"ACTIVE",
"is_confirmed":false,
"email_id":"mikerogers@zylker.com ",
"first_name":"Michael",
"last_name":"Rogers",
"created_time":"Aug 17, 2021 04:55 PM",
"role_details":{
"role_name":"App User",
"role_id":"2136000000007748"
},
"user_type":"App User",
"user_id":"2136000000020040",
"locale":"us|en|Asia/Kolkata",
"time_zone":"Asia/Kolkata",
"project_profiles":[
]
}
全ユーザーの詳細を取得
get_all_users()メソッドは、すべての組織の全ユーザーの詳細を取得できます。
レスポンスには、すべてのユーザーの姓、ロールのリスト、ユーザータイプ、メールアドレス、userID、zuid、タイムゾーンなどの詳細が返されます。
以下で使用されているコンポーネントインスタンスauthentication_serviceの詳細については、こちらのセクションを参照してください。
#すべてのユーザーの詳細を取得する
authentication_service = app.authentication()
user_details = authentication_service.get_all_users()
サンプルレスポンスを以下に示します：
[
{
"zuid":"1005648252",
"org_id":"1005648253",
"status":"ACTIVE",
"is_confirmed":false,
"email_id":"p.boyle@zylker.com",
"first_name":"Parker",
"last_name":"Boyle",
"created_time":"Aug 13, 2021 01:36 PM",
"modified_time":"Aug 13, 2021 01:36 PM",
"invited_time":"Aug 13, 2021 01:36 PM",
"role_details":{
"role_name":"App User",
"role_id":"2136000000007748"
},
"user_type":"App User",
"user_id":"2136000000007774",
"locale":"us|en|Asia/Kolkata",
"time_zone":"Asia/Kolkata",
"project_profiles":[
]
},
{
“zuid”:“1005665160”,
“org_id”:“1005665245”,
“status”:“ACTIVE”,
“is_confirmed”:false,
“email_id”:“rsmith@zylker.com “,
“first_name”:“Robert”,
“last_name”:“Smith”,
“created_time”:“Aug 17, 2021 04:55 PM”,
“modified_time”:“Aug 17, 2021 04:55 PM”,
“invited_time”:“Aug 17, 2021 04:55 PM”,
“role_details”:{
“role_name”:“App User”,
“role_id”:“2136000000007748”
},
“user_type”:“App User”,
“user_id”:“2136000000020040”,
“locale”:“us|en|Asia/Kolkata”,
“time_zone”:“Asia/Kolkata”,
“project_profiles”:[
]
}
]
組織内の全ユーザーの詳細を取得
特定の組織に属するユーザーを取得するには、org_idをget_all_users()メソッドにパラメータとして渡します。
以下で使用されているコンポーネントインスタンスauthentication_serviceの詳細については、こちらのセクションを参照してください。
使用するパラメータ
| パラメータ名 | データ型 | 定義 |
|---|---|---|
| org_id | String | 任意パラメータです。ユーザー詳細を取得する組織のIDを格納します。`org_id`が指定されない場合、すべての組織のすべてのユーザーの詳細が取得されます。 |
#すべてのユーザーの詳細を取得する
authentication_service = app.authentication()
user_details = authentication_service.get_all_users(1293028)
サンプルレスポンスを以下に示します：
[
{
"zuid":"1005648252",
"org_id":"1005648253",
"status":"ACTIVE",
"is_confirmed":false,
"email_id":"roger.p@zylker.com",
"first_name":"Roger",
"last_name":"Parkinson",
"created_time":"Aug 13, 2021 01:36 PM",
"modified_time":"Aug 13, 2021 01:36 PM",
"invited_time":"Aug 13, 2021 01:36 PM",
"role_details":{
"role_name":"App User",
"role_id":"2136000000007748"
},
"user_type":"App User",
"user_id":"2136000000007774",
"locale":"us|en|Asia/Kolkata",
"time_zone":"Asia/Kolkata",
"project_profiles":[
]
}
]
最終更新日 2026-03-30 13:40:30 +0530 IST
Yes
No
Thank you for your feedback!
Send your feedback to us