UserTokenController
extends Controller
in package
User token management controller
Handles personal access token operations for users including listing active sessions, viewing token details with security information, and revoking tokens for security management.
Attributes
- #[Middleware]
- ['auth:sanctum', 'ability:' . \App\Models\TokenAbility::ACCESS_API->value, 'force.json']
- #[Prefix]
- 'users/tokens'
Table of Contents
Methods
- getUserTokens() : AnonymousResourceCollection
- Get a paginated collection of user's personal access tokens
- revokeToken() : Response
- Revoke a specific personal access token
- denyWithStatus() : mixed
- gateCheckExecuteJob() : mixed
- gateCheckViewDashboard() : mixed
- noContent() : mixed
Methods
getUserTokens()
Get a paginated collection of user's personal access tokens
public
getUserTokens(UserTokenIndexRequest $request) : AnonymousResourceCollection
Returns all active tokens for the authenticated user including detailed security information such as device details, IP history, location data, and usage statistics for session management.
Parameters
- $request : UserTokenIndexRequest
-
Request with pagination and filtering parameters
Tags
Attributes
- #[Get]
- '/{user}'
- 'api.user-tokens.index'
Return values
AnonymousResourceCollectionrevokeToken()
Revoke a specific personal access token
public
revokeToken(Request $request, PersonalAccessToken $token) : Response
Permanently revokes a personal access token, ending the associated session. Users can only revoke their own tokens. Includes security validation to prevent unauthorized token revocation.
Parameters
- $request : Request
-
Authenticated request
- $token : PersonalAccessToken
-
The token to revoke
Tags
Attributes
- #[Delete]
- '/{token}'
- 'api.user-tokens.revoke'
Return values
ResponsedenyWithStatus()
protected
denyWithStatus(string $message, int $status) : mixed
Parameters
- $message : string
- $status : int
gateCheckExecuteJob()
protected
gateCheckExecuteJob() : mixed
gateCheckViewDashboard()
protected
gateCheckViewDashboard() : mixed
noContent()
protected
noContent() : mixed