user Token Verify
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 userErrorsuser
Errorsuser Errors UserTokenVerifyUserError[]UserTokenVerifyUserError[]requiredrequired List of errors that occured while executing the mutation.
- Anchor to publicIdpublic
Idpublic Id string | nullstring | null The public ID of the user.
- Anchor to tokenExpiresAttoken
Expires Attoken Expires At ISO8601DateTime | nullISO8601DateTime | null The expiration date of the token.
- Anchor to userStateuser
Stateuser State 'VERIFIED' | 'GUEST' | null'VERIFIED' | 'GUEST' | null The state of the user.
- Anchor to userIdentifieruser
Identifieruser Identifier string | 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
Examples
graphql
mutation VerifyUserToken($token: String!) {
userTokenVerify(token: $token) {
tokenExpiresAt
publicId
userErrors {
code
field
message
}
}
}
Examples
graphql
mutation VerifyUserToken($token: String!) { userTokenVerify(token: $token) { tokenExpiresAt publicId userErrors { code field message } } }
Was this page helpful?