<!-- /* * Your installation or use of this SugarCRM file is subject to the applicable * terms available at * http://support.sugarcrm.com/Resources/Master_Subscription_Agreements/. * If you do not agree to all of the applicable terms or do not have the * authority to bind the entity as an authorized representative, then do not * install or use this SugarCRM file. * * Copyright (C) SugarCRM Inc. All rights reserved. */ --> <h2>Overview</h2> <span class="lead"> Allows an administrator of the Users module to trigger an email to be sent to a User requesting them to reset their password </span> <h2>Request Arguments</h2> <table class="table table-hover"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead> <tbody> <tr> <td> userId </td> <td> String </td> <td> The ID of the User who should receive the reset password request </td> <td> True </td> </tr> </tbody> </table> <h3>Request</h3> <pre class="pre-scrollable"> { "userId":"dacac8a8-bf9d-11ee-b819-acde48001122" } </pre> <h2>Response Arguments</h2> <table class="table table-hover"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td> &lt;record field&gt; </td> <td> &lt;record field type&gt; </td> <td> Returns the fields for the specified User </td> </tr> </tbody> </table> <h3>Response</h3> <pre class="pre-scrollable"> { "id": "dacac8a8-bf9d-11ee-b819-acde48001122", "user_name": "user1", "user_hash": null, "system_generated_password": false, "pwd_last_changed": "", "authenticate_id": "", "sugar_login": true, "picture": "", "first_name": "", "last_name": "User1", "full_name": "User1", "name": "User1", "is_admin": false, "external_auth_only": false, "receive_notifications": true, "send_email_on_mention": false, "description": "", "date_entered": "2024-01-30T10:31:58-08:00", "date_modified": "2024-01-30T10:31:58-08:00", "last_login": "", "modified_user_id": "1", "modified_by_name": "", "created_by": "1", "created_by_name": "Administrator", "created_by_link": { "full_name": "Administrator", "id": "1", "_acl": { "fields": { "pwd_last_changed": { "write": "no", "create": "no" }, "last_login": { "write": "no", "create": "no" } }, "_hash": "6d408abe1708e7afd72eaecf780699c2" } }, "title": "", "department": "", "phone_home": "", "phone_mobile": "", "phone_work": "", "phone_other": "", "phone_fax": "", "status": "Active", "address_street": "", "address_city": "", "address_state": "", "address_country": "", "address_postalcode": "", "UserType": "", "license_type": [ "SUGAR_SERVE" ], "portal_user_password": "", "mail_credentials": null, "email_link_type": "", "export_delimiter": "", "default_export_charset": "", "use_real_names": "", "reminder_time": "", "email_reminder_time": "", "appearance": "", "site_url": "", "field_name_placement": "", "user_tabs": null, "number_pinned_modules": null, "datef": "", "timef": "", "default_currency_significant_digits": "", "num_grp_sep": "", "timezone": "", "dec_sep": "", "currency": "", "default_locale_name_format": "", "currency_show_preferred": "", "currency_create_in_preferred": "", "sugarpdf_pdf_font_name_main": "", "sugarpdf_pdf_font_size_main": null, "sugarpdf_pdf_font_name_data": "", "sugarpdf_pdf_font_size_data": null, "calendar_publish_key": "", "calendar_publish_location": "", "calendar_search_location": "", "calendar_ical_subscription_url": "", "fdow": "", "default_team": "1", "business_center_name": "", "business_centers": { "name": "", "id": "", "_acl": { "fields": [], "_hash": "654d337e0e912edaa00dbb0fb3dc3c17" } }, "business_center_id": "", "team_count": "", "team_count_link": { "team_count": "", "id": "1", "_acl": { "fields": [], "_hash": "654d337e0e912edaa00dbb0fb3dc3c17" } }, "team_name": [ { "id": "1", "name": "Global", "name_2": "", "primary": true, "selected": false } ], "deleted": false, "portal_only": false, "show_on_employees": true, "employee_status": "Active", "messenger_id": "", "messenger_type": "", "reports_to_id": "", "reports_to_name": "", "reports_to_link": { "name": "", "id": "", "_acl": { "fields": [], "_hash": "654d337e0e912edaa00dbb0fb3dc3c17" } }, "email1": "test@example.com", "email": [ { "email_address": "test@example.com", "invalid_email": false, "opt_out": false, "email_address_id": "dacf24b6-bf9d-11ee-9d80-acde48001122", "primary_address": true, "reply_to_address": false } ], "is_group": false, "c_accept_status_fields": "", "calls": { "id": "" }, "m_accept_status_fields": "", "meetings": { "id": "" }, "accept_status_id": "", "accept_status_name": "", "accept_status_calls": "", "accept_status_meetings": "", "accept_status_messages": "", "preferred_language": "", "acl_role_set_id": "", "site_user_id": "de66ff945c4e9ea1a938f7080df05409a26f5f7d44bee59248f83b9711efe53a", "cookie_consent": false, "cookie_consent_received_on": "", "sync_key": "", "customer_journey_access": false, "customer_journey_last_active": "", "my_favorite": false, "_acl": { "fields": {} } } </pre> <h2>Change Log</h2> <table class="table table-hover"> <tr> <th>Version</th> <th>Change</th> </tr> <tr> <td> v11_24 </td> <td> Added <code>/password/adminRequest</code> POST endpoint. </td> </tr> </table>