Auth0-PHP

InvalidTokenException extends Exception
in package
implements Auth0Exception

FinalYes
Tags
codeCoverageIgnore

Table of Contents

Interfaces

Auth0Exception
Represents all errors generated by SDK itself.

Constants

MSG_BAD_EVENT_CLAIM  : string = '`%s` member in the `events` claim must be an %s'
MSG_BAD_SEPARATORS  : string = 'The JWT string must contain two dots'
MSG_BAD_SIGNATURE  : string = 'Cannot verify signature'
MSG_BAD_SIGNATURE_INCOMPATIBLE_ALGORITHM  : string = 'Cannot verify signature: Key uses an incompati...
MSG_BAD_SIGNATURE_MISSING_KID  : string = 'Cannot verify signature: JWKS did not contain...
MSG_ID_TOKEN_USED_AS_ACCESS_TOKEN  : string = 'ID token cannot be validated as an access toke...
MSG_LOGOUT_TOKEN_NONCE_PRESENT  : string = 'Valid logout tokens cannot include `nonce` cla...
MSG_MISMATCHED_AUD_CLAIM  : string = 'Audience (aud) claim mismatch in the token; ex...
MSG_MISMATCHED_AUTH_TIME_CLAIM  : string = 'Authentication Time (auth_time) claim in the t...
MSG_MISMATCHED_AZP_CLAIM  : string = 'Authorized Party (azp) claim mismatch in the I...
MSG_MISMATCHED_EVENTS_CLAIM  : string = 'Events (events) claim mismatch in the token; e...
MSG_MISMATCHED_EXP_CLAIM  : string = 'Expiration Time (exp) claim error in the token...
MSG_MISMATCHED_ISS_CLAIM  : string = 'Issuer (iss) claim mismatch in the token; expe...
MSG_MISMATCHED_NONCE_CLAIM  : string = 'Nonce (nonce) claim mismatch in the token; exp...
MSG_MISSING_ALG_HEADER  : string = 'Provided token is missing a alg header'
MSG_MISSING_AUDIENCE_CLAIM  : string = 'Audience (aud) claim must be a string or array...
MSG_MISSING_AUTH_TIME_CLAIM  : string = 'Authentication Time (auth_time) claim must be...
MSG_MISSING_AZP_CLAIM  : string = 'Authorized Party (azp) claim must be a string...
MSG_MISSING_EVENTS_CLAIM  : string = 'Events (events) claim must be an array of stri...
MSG_MISSING_EXP_CLAIM  : string = 'Expiration Time (exp) claim must be a number p...
MSG_MISSING_IAT_CLAIM  : string = 'Issued At (iat) claim must be a number present...
MSG_MISSING_ISS_CLAIM  : string = 'Issuer (iss) claim must be a string present in...
MSG_MISSING_KID_HEADER  : string = 'Provided token is missing a kid header'
MSG_MISSING_NONCE_CLAIM  : string = 'Nonce (nonce) claim must be a string present i...
MSG_MISSING_SID_CLAIM  : string = 'Identifier (sid) claim must be a number presen...
MSG_MISSING_SUB_AND_SID_CLAIMS  : string = 'Subject (sub) or Identifier (sid) claim must b...
MSG_MISSING_SUB_CLAIM  : string = 'Subject (sub) claim must be a string present i...
MSG_ORGANIZATION_CLAIM_BAD  : string = 'Token organization claim (`org_id` or `org_nam...
MSG_ORGANIZATION_CLAIM_MISSING  : string = 'Token organization claim (`org_id` or `org_nam...
MSG_ORGANIZATION_CLAIM_UNEXPECTED  : string = 'Token organization claim (`org_id` or `org_nam...
MSG_ORGANIZATION_CLAIM_UNMATCHED  : string = 'Token organization claim (`org_id` or `org_nam...
MSG_REQUIRES_CLIENT_SECRET  : string = 'Cannot verify signature: Client secret must be...
MSG_REQUIRES_JWKS_URI  : string = 'Cannot verify signature: JWKS uri was not conf...
MSG_UNEXPECTED_SIGNING_ALGORITHM  : string = 'Expected token signed with "%s" algorithm, but...
MSG_UNSUPPORTED_SIGNING_ALGORITHM  : string = 'Signature algorithm of "%s" is not supported....

Methods

badEventClaim()  : self
badSeparators()  : self
badSignature()  : self
badSignatureIncompatibleAlgorithm()  : self
badSignatureMissingKid()  : self
idTokenUsedAsAccessToken()  : self
jsonError()  : self
logoutTokenNoncePresent()  : self
mismatchedAudClaim()  : self
mismatchedAuthTimeClaim()  : self
mismatchedAzpClaim()  : self
mismatchedEventsClaim()  : self
mismatchedExpClaim()  : self
mismatchedIssClaim()  : self
mismatchedNonceClaim()  : self
missingAlgHeader()  : self
missingAudienceClaim()  : self
missingAuthTimeClaim()  : self
missingAzpClaim()  : self
missingEventsClaim()  : self
missingExpClaim()  : self
missingIatClaim()  : self
missingIssClaim()  : self
missingKidHeader()  : self
missingNonceClaim()  : self
missingSidClaim()  : self
missingSubAndSidClaims()  : self
missingSubClaim()  : self
requiresClientSecret()  : self
requiresJwksUri()  : self
unexpectedSigningAlgorithm()  : self
unsupportedSigningAlgorithm()  : self

Constants

MSG_BAD_EVENT_CLAIM

public string MSG_BAD_EVENT_CLAIM = '`%s` member in the `events` claim must be an %s'

MSG_BAD_SEPARATORS

public string MSG_BAD_SEPARATORS = 'The JWT string must contain two dots'

MSG_BAD_SIGNATURE_INCOMPATIBLE_ALGORITHM

public string MSG_BAD_SIGNATURE_INCOMPATIBLE_ALGORITHM = 'Cannot verify signature: Key uses an incompatible signing algorithm'

MSG_BAD_SIGNATURE_MISSING_KID

public string MSG_BAD_SIGNATURE_MISSING_KID = 'Cannot verify signature: JWKS did not contain the key specified by the token'

MSG_ID_TOKEN_USED_AS_ACCESS_TOKEN

public string MSG_ID_TOKEN_USED_AS_ACCESS_TOKEN = 'ID token cannot be validated as an access token (detected nonce claim)'

MSG_LOGOUT_TOKEN_NONCE_PRESENT

public string MSG_LOGOUT_TOKEN_NONCE_PRESENT = 'Valid logout tokens cannot include `nonce` claims'

MSG_MISMATCHED_AUD_CLAIM

public string MSG_MISMATCHED_AUD_CLAIM = 'Audience (aud) claim mismatch in the token; expected "%s", found "%s"'

MSG_MISMATCHED_AUTH_TIME_CLAIM

public string MSG_MISMATCHED_AUTH_TIME_CLAIM = 'Authentication Time (auth_time) claim in the token indicates that too much time has passed since the last end-user authentication. Current time %d is after last auth at %d'

MSG_MISMATCHED_AZP_CLAIM

public string MSG_MISMATCHED_AZP_CLAIM = 'Authorized Party (azp) claim mismatch in the ID token; expected "%s", found "%s"'

MSG_MISMATCHED_EVENTS_CLAIM

public string MSG_MISMATCHED_EVENTS_CLAIM = 'Events (events) claim mismatch in the token; expected "%s", found "%s"'

MSG_MISMATCHED_EXP_CLAIM

public string MSG_MISMATCHED_EXP_CLAIM = 'Expiration Time (exp) claim error in the token; current time %d is after expiration time %d'

MSG_MISMATCHED_ISS_CLAIM

public string MSG_MISMATCHED_ISS_CLAIM = 'Issuer (iss) claim mismatch in the token; expected "%s", found "%s"'

MSG_MISMATCHED_NONCE_CLAIM

public string MSG_MISMATCHED_NONCE_CLAIM = 'Nonce (nonce) claim mismatch in the token; expected "%s", found "%s"'

MSG_MISSING_ALG_HEADER

public string MSG_MISSING_ALG_HEADER = 'Provided token is missing a alg header'

MSG_MISSING_AUDIENCE_CLAIM

public string MSG_MISSING_AUDIENCE_CLAIM = 'Audience (aud) claim must be a string or array of strings present in the token'

MSG_MISSING_AUTH_TIME_CLAIM

public string MSG_MISSING_AUTH_TIME_CLAIM = 'Authentication Time (auth_time) claim must be a number present in the token when Max Age is specified'

MSG_MISSING_AZP_CLAIM

public string MSG_MISSING_AZP_CLAIM = 'Authorized Party (azp) claim must be a string present in the token when Audience (aud) claim has multiple values'

MSG_MISSING_EVENTS_CLAIM

public string MSG_MISSING_EVENTS_CLAIM = 'Events (events) claim must be an array of strings present in the token'

MSG_MISSING_EXP_CLAIM

public string MSG_MISSING_EXP_CLAIM = 'Expiration Time (exp) claim must be a number present in the token'

MSG_MISSING_IAT_CLAIM

public string MSG_MISSING_IAT_CLAIM = 'Issued At (iat) claim must be a number present in the token'

MSG_MISSING_ISS_CLAIM

public string MSG_MISSING_ISS_CLAIM = 'Issuer (iss) claim must be a string present in the token'

MSG_MISSING_KID_HEADER

public string MSG_MISSING_KID_HEADER = 'Provided token is missing a kid header'

MSG_MISSING_NONCE_CLAIM

public string MSG_MISSING_NONCE_CLAIM = 'Nonce (nonce) claim must be a string present in the token'

MSG_MISSING_SID_CLAIM

public string MSG_MISSING_SID_CLAIM = 'Identifier (sid) claim must be a number present in the token'

MSG_MISSING_SUB_AND_SID_CLAIMS

public string MSG_MISSING_SUB_AND_SID_CLAIMS = 'Subject (sub) or Identifier (sid) claim must be a string present in the token'

MSG_MISSING_SUB_CLAIM

public string MSG_MISSING_SUB_CLAIM = 'Subject (sub) claim must be a string present in the token'

MSG_ORGANIZATION_CLAIM_BAD

public string MSG_ORGANIZATION_CLAIM_BAD = 'Token organization claim (`org_id` or `org_name`) must be a string'

MSG_ORGANIZATION_CLAIM_MISSING

public string MSG_ORGANIZATION_CLAIM_MISSING = 'Token organization claim (`org_id` or `org_name`) was not found'

MSG_ORGANIZATION_CLAIM_UNEXPECTED

public string MSG_ORGANIZATION_CLAIM_UNEXPECTED = 'Token organization claim (`org_id` or `org_name`) was not expected'

MSG_ORGANIZATION_CLAIM_UNMATCHED

public string MSG_ORGANIZATION_CLAIM_UNMATCHED = 'Token organization claim (`org_id` or `org_name`) is not allowed'

MSG_REQUIRES_CLIENT_SECRET

public string MSG_REQUIRES_CLIENT_SECRET = 'Cannot verify signature: Client secret must be configured to verify HS256 signatures'

MSG_REQUIRES_JWKS_URI

public string MSG_REQUIRES_JWKS_URI = 'Cannot verify signature: JWKS uri was not configured properly'

MSG_UNEXPECTED_SIGNING_ALGORITHM

public string MSG_UNEXPECTED_SIGNING_ALGORITHM = 'Expected token signed with "%s" algorithm, but token uses "%s"'

MSG_UNSUPPORTED_SIGNING_ALGORITHM

public string MSG_UNSUPPORTED_SIGNING_ALGORITHM = 'Signature algorithm of "%s" is not supported. Expected the token to be signed with "RS256" or "HS256"'

Methods

badEventClaim()

public static badEventClaim(string $claim, string $format[, Throwable|null $previous = null ]) : self
Parameters
$claim : string
$format : string
$previous : Throwable|null = null
Return values
self

badSeparators()

public static badSeparators([Throwable|null $previous = null ]) : self
Parameters
$previous : Throwable|null = null
Return values
self

badSignature()

public static badSignature([Throwable|null $previous = null ]) : self
Parameters
$previous : Throwable|null = null
Return values
self

badSignatureIncompatibleAlgorithm()

public static badSignatureIncompatibleAlgorithm([Throwable|null $previous = null ]) : self
Parameters
$previous : Throwable|null = null
Return values
self

badSignatureMissingKid()

public static badSignatureMissingKid([Throwable|null $previous = null ]) : self
Parameters
$previous : Throwable|null = null
Return values
self

idTokenUsedAsAccessToken()

public static idTokenUsedAsAccessToken([Throwable|null $previous = null ]) : self
Parameters
$previous : Throwable|null = null
Return values
self

jsonError()

public static jsonError(string $message[, Throwable|null $previous = null ]) : self
Parameters
$message : string
$previous : Throwable|null = null
Return values
self

logoutTokenNoncePresent()

public static logoutTokenNoncePresent([Throwable|null $previous = null ]) : self
Parameters
$previous : Throwable|null = null
Return values
self

mismatchedAudClaim()

public static mismatchedAudClaim(string $expected, string $found[, Throwable|null $previous = null ]) : self
Parameters
$expected : string
$found : string
$previous : Throwable|null = null
Return values
self

mismatchedAuthTimeClaim()

public static mismatchedAuthTimeClaim(int $now, int $expired[, Throwable|null $previous = null ]) : self
Parameters
$now : int
$expired : int
$previous : Throwable|null = null
Return values
self

mismatchedAzpClaim()

public static mismatchedAzpClaim(string $expected, string $found[, Throwable|null $previous = null ]) : self
Parameters
$expected : string
$found : string
$previous : Throwable|null = null
Return values
self

mismatchedEventsClaim()

public static mismatchedEventsClaim(string $expected, string $found[, Throwable|null $previous = null ]) : self
Parameters
$expected : string
$found : string
$previous : Throwable|null = null
Return values
self

mismatchedExpClaim()

public static mismatchedExpClaim(int $now, int $expired[, Throwable|null $previous = null ]) : self
Parameters
$now : int
$expired : int
$previous : Throwable|null = null
Return values
self

mismatchedIssClaim()

public static mismatchedIssClaim(string $expected, string $found[, Throwable|null $previous = null ]) : self
Parameters
$expected : string
$found : string
$previous : Throwable|null = null
Return values
self

mismatchedNonceClaim()

public static mismatchedNonceClaim(string $expected, string $found[, Throwable|null $previous = null ]) : self
Parameters
$expected : string
$found : string
$previous : Throwable|null = null
Return values
self

missingAlgHeader()

public static missingAlgHeader([Throwable|null $previous = null ]) : self
Parameters
$previous : Throwable|null = null
Return values
self

missingAudienceClaim()

public static missingAudienceClaim([Throwable|null $previous = null ]) : self
Parameters
$previous : Throwable|null = null
Return values
self

missingAuthTimeClaim()

public static missingAuthTimeClaim([Throwable|null $previous = null ]) : self
Parameters
$previous : Throwable|null = null
Return values
self

missingAzpClaim()

public static missingAzpClaim([Throwable|null $previous = null ]) : self
Parameters
$previous : Throwable|null = null
Return values
self

missingEventsClaim()

public static missingEventsClaim([Throwable|null $previous = null ]) : self
Parameters
$previous : Throwable|null = null
Return values
self

missingExpClaim()

public static missingExpClaim([Throwable|null $previous = null ]) : self
Parameters
$previous : Throwable|null = null
Return values
self

missingIatClaim()

public static missingIatClaim([Throwable|null $previous = null ]) : self
Parameters
$previous : Throwable|null = null
Return values
self

missingIssClaim()

public static missingIssClaim([Throwable|null $previous = null ]) : self
Parameters
$previous : Throwable|null = null
Return values
self

missingKidHeader()

public static missingKidHeader([Throwable|null $previous = null ]) : self
Parameters
$previous : Throwable|null = null
Return values
self

missingNonceClaim()

public static missingNonceClaim([Throwable|null $previous = null ]) : self
Parameters
$previous : Throwable|null = null
Return values
self

missingSidClaim()

public static missingSidClaim([Throwable|null $previous = null ]) : self
Parameters
$previous : Throwable|null = null
Return values
self

missingSubAndSidClaims()

public static missingSubAndSidClaims([Throwable|null $previous = null ]) : self
Parameters
$previous : Throwable|null = null
Return values
self

missingSubClaim()

public static missingSubClaim([Throwable|null $previous = null ]) : self
Parameters
$previous : Throwable|null = null
Return values
self

requiresClientSecret()

public static requiresClientSecret([Throwable|null $previous = null ]) : self
Parameters
$previous : Throwable|null = null
Return values
self

requiresJwksUri()

public static requiresJwksUri([Throwable|null $previous = null ]) : self
Parameters
$previous : Throwable|null = null
Return values
self

unexpectedSigningAlgorithm()

public static unexpectedSigningAlgorithm(string $expected, string $found[, Throwable|null $previous = null ]) : self
Parameters
$expected : string
$found : string
$previous : Throwable|null = null
Return values
self

unsupportedSigningAlgorithm()

public static unsupportedSigningAlgorithm(string $algorithm[, Throwable|null $previous = null ]) : self
Parameters
$algorithm : string
$previous : Throwable|null = null
Return values
self
On this page

Search results