AppCheckTokenOptions interface

Interface representing App Check token options.

Signature:

export interface AppCheckTokenOptions 

Properties

Property Type Description
jti string Specifies the desired jti claim (Section 4.1.7 of RFC 7519) in the returned App Check token. Limited-use App Check tokens with the same jti will be counted as the same token for the purposes of replay protection.If this field is omitted or is empty, a randomly generated jti will be used in the returned App Check token.An error is returned if this field is specified without setting limitedUse to true.
limitedUse boolean Specifies whether this token is for a limited use context. To enable this token to be used with the replay protection feature, set this to true. The default value is false.
ttlMillis number The length of time, in milliseconds, for which the App Check token will be valid. This value must be between 30 minutes and 7 days, inclusive.

AppCheckTokenOptions.jti

Specifies the desired jti claim (Section 4.1.7 of RFC 7519) in the returned App Check token. Limited-use App Check tokens with the same jti will be counted as the same token for the purposes of replay protection.

If this field is omitted or is empty, a randomly generated jti will be used in the returned App Check token.

An error is returned if this field is specified without setting limitedUse to true.

Signature:

jti?: string;

AppCheckTokenOptions.limitedUse

Specifies whether this token is for a limited use context. To enable this token to be used with the replay protection feature, set this to true. The default value is false.

Signature:

limitedUse?: boolean;

AppCheckTokenOptions.ttlMillis

The length of time, in milliseconds, for which the App Check token will be valid. This value must be between 30 minutes and 7 days, inclusive.

Signature:

ttlMillis?: number;