Type Alias TenantTokenGeneratorOptions

Type declaration

• Optionalalgorithm?: `HS${256 | 384 | 512}`

  Encryption algorithm used to sign the JWT. Supported values by Meilisearch are HS256, HS384, HS512. (HS[number] means HMAC using SHA-[number])

  Default Value

  "HS256"

  See

  https://www.meilisearch.com/docs/learn/security/generate_tenant_token_scratch#prepare-token-header

• apiKey: string

  API key used to sign the token.

• apiKeyUid: string

  The uid of the api key used as issuer of the token.

  See

  https://www.meilisearch.com/docs/learn/security/tenant_token_reference#api-key-uid

• OptionalexpiresAt?: number | Date

  UNIX timestamp or Date object at which the token expires.

  See

  https://www.meilisearch.com/docs/learn/security/tenant_token_reference#expiry-date

• Optionalforce?: boolean

  By default if a non-safe environment is detected, an error is thrown. Setting this to true skips environment detection. This is intended for server-side environments where detection fails or usage in a browser is intentional (Use at your own risk).

  Default Value

  false

• OptionalsearchRules?: TokenSearchRules

  Search rules that are applied to every search.

  Default Value

  ["*"]