Revoke All Tokens User

POST/api/v2/admin/users/{userId}/revokeAllTokens

Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Revoke all active authentication tokens for the user including active browser sessions and long-lived development tokens. If the user has active sessions in a browser, this will force re-authentication.

The caller must have permission to manage users for the target user's organization.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:admin-write.

Path parameters

userId

string

The ID of a Foundry Group or User.

Query parameters

preview

boolean

optional

Enables the use of preview functionality.

Examples

Request

Copied!

curl -X POST \
	-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/admin/users/f05f8da4-b84c-4fca-9c77-8af0b13d11de/revokeAllTokens?preview=true"

Error responses

Error Name
`RevokeAllTokensUserPermissionDenied`	Error Code	`PERMISSION_DENIED`
	Status Code	403
	Description	Could not revokeAllTokens the User.
	Parameters	`userId`
`UserNotFound`	Error Code	`NOT_FOUND`
	Status Code	404
	Description	The given User could not be found.
	Parameters	`userId`

See Errors for a general overview of errors in the platform.