userTokenVerify
Verifies a user token. See Verifying requests for more details.
Anchor to inputInput
Input arguments for the mutation.
- Anchor to tokentokentokenstringstringrequiredrequired
The temporary user token to verify.
Anchor to return typeReturn type
This mutation returns a object with the following fields:
- Anchor to userErrorsuserErrorsuserErrorsUserTokenVerifyUserError[]UserTokenVerifyUserError[]requiredrequired
List of errors that occured while executing the mutation.
- Anchor to publicIdpublicIdpublicIdstring | nullstring | null
The public ID of the user.
- Anchor to tokenExpiresAttokenExpiresAttokenExpiresAtISO8601DateTime | nullISO8601DateTime | null
The expiration date of the token.
- Anchor to userStateuserStateuserState'VERIFIED' | 'GUEST' | null'VERIFIED' | 'GUEST' | null
The state of the user.
- Anchor to userIdentifieruserIdentifieruserIdentifierstring | nullstring | nulldeprecateddeprecated
A permanent identifier for the user.
DeprecatedUse publicId instead.
Deprecated:Use publicId instead.
ISO8601DateTime
stringUserTokenVerifyUserError
A user or client error that could occur during the execution of the `userTokenVerify` mutation.
- code
Error code associated with the error.
| 'TOKEN_INVALID' | 'TOKEN_EXPIRED' | 'INVALID_MINI' | 'USER_NOT_FOUND' - field
Which input value this error came from.
string[] - message
A description of the error.
string
Was this page helpful?