Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

services.pizauth.enable

Whether to enable Pizauth, a commandline OAuth2 authentication daemon .

Type: boolean

Default:

false

Example:

true

Declared by:

services.pizauth.package

The pizauth package to use.

Type: package

Default:

pkgs.pizauth

Declared by:

services.pizauth.accounts

Pizauth accounts that should be configured

Type: attribute set of (submodule)

Default:

{ }

Declared by:

services.pizauth.accounts.<name>.authUri

The OAuth2 server’s authentication URI.

Type: string

Declared by:

services.pizauth.accounts.<name>.clientId

The OAuth2 client ID.

Type: string

Declared by:

services.pizauth.accounts.<name>.clientSecret

The OAuth2 client secret.

Type: null or string

Default:

null

Declared by:

services.pizauth.accounts.<name>.extraConfig

Additional configuration that will be added to the account configuration. See pizauth.conf(5) for available options.

Type: null or string

Default:

null

Declared by:

services.pizauth.accounts.<name>.loginHint

An optional login hint for the account provider.

Type: null or string

Default:

null

Declared by:

services.pizauth.accounts.<name>.name

Unique identifier of the account. This is set to the attribute name of the account configuration.

Type: string (read only)

Declared by:

services.pizauth.accounts.<name>.scopes

The scopes which the OAuth2 token will give access to. Optional. Note that Office365 requires the non-standard “offline_access” scope to be specified in order for pizauth to be able to operate successfully.

Type: null or (list of string)

Default:

[ ]

Example:

[
  "https://outlook.office365.com/IMAP.AccessAsUser.All"
  "https://outlook.office365.com/SMTP.Send"
  "offline_access"
]

Declared by:

services.pizauth.accounts.<name>.tokenUri

The OAuth2 server’s token URI.

Type: string

Declared by:

services.pizauth.extraConfig

Additional global configuration. See pizauth.conf(5) for a available options.

Type: null or string

Default:

null

Declared by: