JWTOptions

Extends \io\vertx\jphp\ext\jwt\JWTOptions

Options related to creation of new tokens.

If any expiresInMinutes, audience, subject, issuer are not provided, there is no default. The jwt generated won't include those properties in the payload.

Generated JWTs will include an iat claim by default unless noTimestamp is specified.

package	Default

Methods

JWTOptions constructor

__construct( $jwtOptions = null)

Arguments

$jwtOptions

mixed | null

addAudience

addAudience( $audiences) : $this

Arguments

$audiences

string

Response

$this

addPermission

addPermission( $permissions) : $this

Arguments

$permissions

string

Response

$this

getAlgorithm

getAlgorithm() : string

Response

string

getAudience

getAudience() : array

Response

array

getExpiresInSeconds

getExpiresInSeconds() : integer

Response

integer

getHeader

getHeader() : array

Response

array

getIssuer

getIssuer() : string

Response

string

getLeeway

getLeeway() : integer

Response

integer

getPermissions

getPermissions() : array

Response

array

getSubject

getSubject() : string

Response

string

isIgnoreExpiration

isIgnoreExpiration() : boolean

Response

boolean

isNoTimestamp

isNoTimestamp() : boolean

Response

boolean

setAlgorithm

setAlgorithm( $algorithm) : $this

Arguments

$algorithm

string

Response

$this

setAudience

setAudience( $audience) : $this

Arguments

$audience

string

Response

$this

setExpiresInMinutes

setExpiresInMinutes( $expiresInMinutes) : $this

Arguments

$expiresInMinutes

integer

Response

$this

setExpiresInSeconds

setExpiresInSeconds( $expiresInSeconds) : $this

Arguments

$expiresInSeconds

integer

Response

$this

setHeader

setHeader( $header) : $this

Arguments

$header

array

Response

$this

setIgnoreExpiration

setIgnoreExpiration( $ignoreExpiration) : $this

Arguments

$ignoreExpiration

boolean

Response

$this

setIssuer

setIssuer( $issuer) : $this

Arguments

$issuer

string

Response

$this

setLeeway

setLeeway( $leeway) : $this

Arguments

$leeway

integer

Response

$this

setNoTimestamp

setNoTimestamp( $noTimestamp) : $this

Arguments

$noTimestamp

boolean

Response

$this

setPermissions

setPermissions( $permissions) : $this

Arguments

$permissions

string

Response

$this

setSubject

setSubject( $subject) : $this

Arguments

$subject

string

Response

$this