Interface ApiUser

ApiUser objects are used for authentication against the Icinga 2 API.

Example

object ApiUser "root" {
  password = "mysecretapipassword"
  permissions = [ "*" ]
}

See

interface ApiUser {
    __name: string;
    active: boolean;
    client_cn?: string;
    ha_mode: HAMode;
    original_attributes: Record<string, any>;
    package: string;
    password?: string;
    paused: boolean;
    permissions: string[];
    source_location: SourceLocation;
    templates: string[];
    version: number;
    zone: string;
}

Hierarchy

  • ConfigObject
    • ApiUser

Properties

__name active ha_mode original_attributes package paused source_location templates version zone

config

client_cn? password? permissions

Properties

__name

__name: string

See

lib/base/configobject.ti L59-L68

active

active: boolean

See

lib/base/configobject.ti L75

ha_mode

ha_mode: HAMode

See

lib/base/configobject.ti L83

original_attributes

original_attributes: Record<string, any>

See

lib/base/configobject.ti L87

package

package: string

for example _etc

See

lib/base/configobject.ti L70

paused

paused: boolean

See

lib/base/configobject.ti L76-L78

source_location

source_location: SourceLocation

See

lib/base/configobject.ti L72-L74

templates

templates: string[]

See

lib/base/configobject.ti L71

version

version: number

See

lib/base/configobject.ti L88-L90

zone

zone: string

See

lib/base/configobject.ti L69

config

Optional client_cn

client_cn?: string

Client Common Name (CN).

See

lib/remote/apiuser.ti L16

Optional password

password?: string

Password string. Note: This attribute is hidden in API responses.

See

lib/remote/apiuser.ti L14

permissions

permissions: string[]

Array of permissions. Either as string or dictionary with the keys permission and filter. The latter must be specified as function.

See

Settings

Member Visibility

Theme

On This Page