Actions281
- Accounts Actions
- Account Policy
- Update Account Policy
- GenerateRegenerate Uninstall Password
- Get Uninstall Password Metadata
- Revoke Uninstall Password
- Get Uninstall Password
- Get Account by ID
- Update Account
- Expire an Account
- Reactivate Account
- Revert Policy
- Get Accounts
- Create Account
- Get accounts private
- Available Name
- Get Accounts for Navigation
- Get One Account
- Policy Actions
- UninstallPassword Actions
- Activities Actions
- Agents Actions
- Abort Scan
- Approve Uninstall
- Broadcast Message
- Can run Remote Shell
- Clear Remote Shell
- Connect to Network
- Decommission
- Disable Agent
- Disconnect from Network
- Enable Agent
- Fetch Firewall Rules
- Get Installed Apps for agent
- Initiate Scan
- Mark as uptodate
- Move to Console
- Move between Sites
- Randomize UUID
- Disable Ranger
- Enable Ranger
- Reject uninstall
- Reset Local Config
- Set Persistent Configuration Overrides
- Set External ID
- Shutdown
- Start Remote Profiling
- Start Remote Shell
- Stop Remote Profiling
- Uninstall
- Update Software
- Fetch Files
- Export Agent Logs
- Get Agents
- Get Application
- Count Agents
- Get Passphrase
- Processes
- DEPRECATED Get Agent Available Actions
- Get Agent Available Actions
- Event Throttling
- Flush Event Queue
- Protect
- Purge Crash Dumps
- Purge DB
- Purge Research Data
- Reload
- Restart
- Revoke Token
- Send Crash Dumps
- Send Research Data
- Unprotect
- Randomize DV Host
- Auto Complete
- Count by Filters
- FreeText Filters
- Count Summary
- Get config
- Actions Actions
- Abort Scan
- Approve Uninstall
- Broadcast Message
- Can run Remote Shell
- Clear Remote Shell
- Connect to Network
- Decommission
- Disable Agent
- Disconnect from Network
- Enable Agent
- Fetch Firewall Rules
- Get Installed Apps for agent
- Fetch Logs
- Fetch Firewall Logs
- Initiate Scan
- Mark as uptodate
- Move to Console
- Move between Sites
- Randomize UUID
- Disable Ranger
- Enable Ranger
- Reject uninstall
- Reset Local Config
- Restart
- Set Persistent Configuration Overrides
- Set External ID
- Shutdown
- Settings Actions
- Tasks Actions
- Threats Actions
- Get Enriched Events
- Count Events by Type
- Get Process Event
- Prefetch events
- Get Timeline Limits
- Get Tree
- Threat Analysis
- Threat Appearances
- Connect Agents
- Disconnect Agents
- Get Threat Available Actions
- Create Slim Threat
- Add to Blacklist Deep Visibility
- Mark as Threat Deep Visibility
- Auto Complete
- Count by Filters
- FreeText Filters
- Create Deep Visibility Threat
- Multiple actions for Threats
- Threat Summary
- Get Timeline Categories
- Update Threat Note
- Delete Threat Note
- Get Threat Notes
- Download from cloud
- Get Events
- Get Threat Timeline
- Exclusion Options
- Get Threats
- Add to Blacklist
- Add to Exclusions
- Update Threat Analyst Verdict
- Disable Engines
- Export Threats
- Update Threat External Ticket ID
- Fetch Threat File
- Updated Threat Incident
- Mitigate Threats
- Export Mitigation Report
- Add Note to Multiple
- Explore Actions
- Users Actions
- iFrame Token Details
- Login by iFrame Token
- Get Token
- Revoke iFrame Token
- Disable 2FA
- Enable 2FA
- Auth App
- Sign EULA
- Auth Recovery Code
- Redirect to SSO
- Auth by SSO
- Login
- Login by API Token
- Login by Token
- Send Verification Email
- Validate Verification Token
- Email Verification
- Get User
- Update User
- Delete User
- API Token by User ID
- List users
- Create User
- API Token Details
- Change Password
- Bulk Delete Users
- Enable 2FA App
- Generate API Token
- Generate iFrame Token
- Generate Recovery Code
- Check Global User
- Details Actions
- DeviceReview Actions
- Rbac Actions
- Role Actions
- RemoteScripts Actions
- ReportTasks Actions
- Reports Actions
- ActiveDirectory Actions
- Microsoft Actions
- Notifications Actions
- Recipients Actions
- Sms Actions
- Smtp Actions
- Sso Actions
- Notes Actions
- Download Actions
- Packages Actions
- Update Actions
- Upload Actions
- Software Actions
- 2fa Actions
- Auth Actions
- Login Actions
- SsoSaml2 Actions
- Onboarding Actions
- ApplicationInventory Actions
- ApplicationInventoryCounts Actions
- LastActivityAsSyslog Actions
- Sentinelonerss Actions
- SiteWithAdmin Actions
- Tests Actions
- User Actions
Users → Auth Recovery Code
AI-generatedOverview
This node interacts with the SentinelOne API to authenticate a user using a recovery code. It is useful in scenarios where a user needs to regain access to their account using a recovery code, typically after losing access to their primary two-factor authentication method. The node sends a POST request to the '/web/api/v2.1/users/auth/recovery-code' endpoint with optional custom body, headers, and query parameters, supporting batching, pagination, and debugging options.
Use Case Examples
- Authenticate a user with a recovery code to regain account access when two-factor authentication is unavailable.
- Use custom headers to include additional authentication tokens or metadata in the request.
Properties
| Name | Meaning |
|---|---|
| Options | Additional options for the API request such as custom body, headers, query filters, batching, debug mode, pagination, and timeout settings. |
Output
JSON
jsondebug- Debug information including the actual URL, query parameters, headers, and body sent for the API request, if debug option is enabled.
Dependencies
- An API key credential for SentinelOne API authentication.
Troubleshooting
- Ensure the recovery code and other authentication details are correctly provided in the request body or custom body option.
- Check API credentials and permissions to access the auth recovery code endpoint.
- Enable debug mode to see detailed request and response information for troubleshooting.
- Handle API rate limits by configuring batching and batch intervals appropriately.
- Verify network connectivity to the SentinelOne API endpoint.
Links
- SentinelOne API Documentation - Auth Recovery Code - Official API documentation for the user authentication using recovery code endpoint.