Admin API
HomeLootLocker Console
HomeLootLocker Console
LootLocker
  1. Home
  • Auth
    • v2
      • Send Reset Password Email
      • Reset Password With Token
      • Reset Password
    • Signup
      POST
    • 2FA
      POST
    • Verify Email
      POST
    • Login
      POST
    • Check Reset Password Token
      POST
    • Request Password Reset
      POST
    • Reset Password
      PATCH
    • Logout
      DELETE
  • API Keys
    • Get API Keys
      GET
    • Create API Key
      POST
    • Delete API Key
      DELETE
  • Collectables
    • List Collectables
      GET
    • Get Collectable
      GET
    • Create Collectable
      POST
    • Update Collectable
      PATCH
    • Delete Collectable
      DELETE
  • Heroes and Characters
    • Characters
      • List Character Classes
      • Update Character Type
      • Delete Character Type
    • List Heroes
      GET
    • Get Hero
      GET
    • Create Hero
      POST
    • Update Hero
      PATCH
    • Delete Hero
      DELETE
    • Add to Hero Default Loadout
      POST
    • Delete from Hero Default Loadout
      DELETE
    • Add to Hero Exception List
      POST
    • Delete from Hero Exception List
      DELETE
  • Game
    • Create Game
    • Update Create Game Replies
    • Rotate Game Key
    • Rotate Server Key
    • Delete Game
    • Toggle Feature
    • List Games
    • Get Game Versions
    • Get Game Bones
    • Get Game Settings
    • Get Genres
    • Get Feature Toggle List
    • Get Feature By Name
    • Update Game Information
    • Get Game Info
  • Asset Candidates
    • List Pending Asset Candidates
    • Update Pending Asset Candidate
  • Assets
    • Storage
      • Create Asset Storage Template
      • Update Asset Storage Template
      • List Asset Storage Templates
      • Get Asset Storage Template
      • Delete Asset Storage Template
    • Filters
      • Search Keys
      • Search Values
      • Get To Asset
      • Bulk Edit Filters
    • Flags
      • Bulk Edit Assets Flag
    • Get Asset Contexts
    • Update Asset Contexts
    • Search for Asset
    • Search For UGC Assets
    • Get Selection of Assets
    • Get Asset Files
    • Get Asset List
    • Get Asset Link Types
    • Get Asset Links
    • Add File to Asset
    • Create Asset
    • Update Asset
    • Delete Asset
    • Get Asset Types
    • Get Asset
  • Bones
    • Get Bones
    • Update Bones
  • Players
    • Files
      • Get Files To Player
      • Update Player File
      • Get Files To Player Copy
    • Count Players For Game
    • Player Name
    • Player Platforms
    • Player Inventory
    • Search Players
    • List Players
    • DEPRECATED: Lookup Player Names by IDs
    • Delete Player
    • Get Info
    • List Info
    • Rename
  • Leaderboards
    • Schedules
      • Create new Leaderboard Schedule
      • Get Leaderboard Schedule
      • Delete Leaderboard Schedule
    • Archives
      • List archives
      • Download archive
    • Rewards
      • Add a new Reward
      • Delete rewards by reward ID
    • List Leaderboards
    • Get Leaderboard By ID
    • Create Leaderboard
    • Update Leaderboard
    • Delete Leaderboard
    • Purge Leaderboard
    • Get Score List
    • Get Member Rank
    • Get Members Ranks
    • Update Leaderboard Member Score
    • Delete Leaderboard Member
    • Delete Leaderboard Member On All Boards
  • Files
    • Get Files to Game
    • Update File
    • Update File Copy
    • Delete File
    • Upload File
  • Feature Toggles
    • List Configured Feature Toggles and Settings
    • List All Configured Features
    • Update Feature Toggle
    • Update Feature Toggle - Enable UGC
  • Universal Player Auth
    • Check DNS status
    • Update Auth URL
  • Merging
    • Progressions
      • Get Merge Differences
      • Merge Differences
    • Diff
    • Merge
  • Rarities
    • List Rarities
    • Create Rarity
    • Update Rarity
    • Delete Rarity
  • Preferences
    • Get User Preferences
    • Set User Preference
  • Platforms
    • v1
      • Get Platforms
      • Add Platforms
      • Save Platforms
    • dated-versions
      • Get Platforms
      • Get Platform Settings
      • Update Platform
  • Progressions
    • Tiers
      • Get All Progression Tiers
      • Get Progression Tier By ID
      • Create Progression Tier
      • Update Progression Tier
      • Update Progression Tier Rewards
      • Delete Progression Tier
    • Players
      • Get All Player Progressions
      • Get Player Progressions By ID
      • Add points to player progression
      • Subtract points from player progression
      • Reset player progression
      • Delete player progression
    • Characters
      • Get All Character Progressions
      • Get Character Progressions By ID
      • Add points to Character progression
      • Subtract points from Character progression
      • Reset Character progression
      • Delete Character progression
    • Asset Instances
      • Get All Asset Instance Progressions
      • Get Asset Instance Progressions By ID
      • Add points to Asset Instance progression
      • Subtract points from Asset Instance progression
      • Reset Asset Instance progression
      • Delete Asset Instance progression
    • Get All Progressions
    • Get Progression By ID
    • Create Progression
    • Update Progression
  • User
    • Get User Information
    • Get User Login Information
    • Update User
    • Send Verification Email
    • Verify User Email
    • Request User Password Reset
    • Get All User Information
  • Organisation
    • Get Organisation Users
    • Invite User to Organisation
    • Update Organisation User
    • Update Sign Up Replies
    • Complete Signup
    • Update Name
  • Link Types
    • List Link Types
    • Create Link Type
    • Update Link Type
    • Delete Link Type
  • Events/Missions
    • Get Missions
    • Get Mission Difficulties
    • Create Mission
    • Update Mission
  • Maps
    • Create Map
    • Get Maps
  • White Label Login
    • Get White Label User By Player ID
    • Delete White Label User
  • Rewards
    • Create Progression Reset Reward
    • Create Progression Points Reward
    • Create Currency Reward
    • Create Asset Reward
    • Create Group Reward
    • Get Reward
    • Add Reward To Group
    • Delete Reward From Group
    • Edit Group Name and Description
    • Get Many
  • Moderation Reports
    • Reasons
      • Get Player Report Reasons
      • Get Asset Report Reasons
      • Create Report Reason
      • Update Report Reason
      • Delete Report Reason
    • Get Asset Reports
    • Get Player Reports
    • Get Asset Report Details
    • Get Player Report Details
    • Get Unresolved Report Counts
    • Update Report
    • Resolve all reports for asset
    • Resolve all reports for player
  • Catalogs
    • Prices
      • Append a price to a catalog item
      • Delete Price
    • Store Listings
      • Create Catalog Vendor Mapping
      • Update Vendor Mapping
      • Delete Catalog Vendor Mapping
    • Catalog Items
      • Create a catalog item for a group
      • Create a catalog item for an asset
      • Create a catalog item for an asset (with optional metadata)
      • Create a catalog item for progression points
      • Create a catalog item for progression reset
      • Create a catalog item for a currency
    • Create new catalog
    • Delete Catalog
    • List Catalogs For Game
    • List Catalog Items
    • Update Catalog Name
    • Delete a Catalog Item
    • Toggle Purchasable Status of Catalog Item
  • Currency
    • Create New Currency
    • Create New Denomination For Currency
    • Publish Currency
    • Retract Currency
    • Enable Game API Writes
    • Disable Game API Writes
    • Delete Currency
    • Delete Denomination
    • Get Currency By Game & Code
    • Get Dependents For Currency
    • List Currencies By Game
    • List Denominations By Currency
  • Balances
    • Credit Balance
    • Create Wallet Modifiers
    • Debit Balance
    • List Balances
    • Create New Wallet
    • Get Wallet
    • Get Wallet for Holder
  • Messages
    • List Messages
    • Get Message
    • Create Message
    • Update Message
    • Update Message Copy
  • DLC
    • List DLC
    • Create DLC
    • Get DLC Details
    • Update DLC
  • Player Segments
    • List Player Segments
    • Create Player Segments
    • Get Player Segment
    • Update Player Segment
    • Delete Player Segment
    • Get Segment Players
    • Get Segment Grants
    • Creat Segment Grant
  • Character Classes
    • Get Character Classes
    • Update Character Class
  • Subscriptions
    • Subscribe
    • Get Subscription
    • Update Subscription
    • Unsubscribe Game
    • Get Subscription Management URL
  • Player Operations
    • Get Player Operations
  • Roles
    • Add Role to User
    • Get User Roles
    • Delete User Role
  • Title Config
    • Get Game Config
    • Update Game Config
  • Items
    • Delete asset from player's inventory
  • Entitlements
    • List Entitlements History
    • Get Single Entitlement
  • Feedback
    • Category
      • List
      • Create
      • Update
      • Delete
    • Get
    • Count
    • List
    • Resolve
    • Unresolve
    • Delete
  • Hosts
    • Create
    • List
    • Delete
  • Metadata
    • Metadata Operations
    • List Metadata
    • List Multisource Metadata
  • Triggers
    • List
    • Get
    • Create
    • Delete
    • Update
  • Data Migration
    • Players
    • Player Status
    • Currency
    • Validate
    • Metadata
    • Players Takeout
  • Twitch Drops
    • List Rewards
    • Get Reward
    • Upsert Reward
    • Delete Reward
    • Set up Twitch Drop Campaign
    • List Twitch Drop Campaigns
  • Notifications
    • Send Notification to Player
    • List Notifications
  1. Home

Auth

Initial Authentication Request#

The initial login request is simple in that it just requires the users email and password sent in a POST request.
The response can vary depending if the user has Two-Factor Authentication enabled or not. See examples for more detail.
If the user has Two-Factor Authentication enabled, the mfa_key, sent back has en expiry time of 5 minutes. If the userdoes not manage to input the MFA token during this time, you should present them with the login form again.
In case of an error, the response will have the success property set to false, and there will be an error property with a human readable error message.
Modified at 2024-09-18 13:42:00
Next
Send Reset Password Email
Built with