auth

package
v0.0.0-...-a632b15 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 27, 2025 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Group 

type Group struct {
	pulumi.CustomResourceState

	// Defaults to `""`.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	Name        pulumi.StringOutput    `pulumi:"name"`
}

This resource is used to manage groups.

## Example Usage

```go package main

import ( 

"github.com/NatzkaLabsOpenSource/pulumi-netbox/sdk/go/netbox/auth"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := auth.NewGroup(ctx, "test", &auth.GroupArgs{
			Name: pulumi.String("test-group"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetGroup 

func GetGroup(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *GroupState, opts ...pulumi.ResourceOption) (*Group, error)

GetGroup gets an existing Group resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewGroup 

func NewGroup(ctx *pulumi.Context,
	name string, args *GroupArgs, opts ...pulumi.ResourceOption) (*Group, error)

NewGroup registers a new resource with the given unique name, arguments, and options.

func (*Group) ElementType 

func (*Group) ElementType() reflect.Type

func (*Group) ToGroupOutput 

func (i *Group) ToGroupOutput() GroupOutput

func (*Group) ToGroupOutputWithContext 

func (i *Group) ToGroupOutputWithContext(ctx context.Context) GroupOutput

type GroupArgs 

type GroupArgs struct {
	// Defaults to `""`.
	Description pulumi.StringPtrInput
	Name        pulumi.StringPtrInput
}

The set of arguments for constructing a Group resource.

func (GroupArgs) ElementType 

func (GroupArgs) ElementType() reflect.Type

type GroupArray 

type GroupArray []GroupInput

func (GroupArray) ElementType 

func (GroupArray) ElementType() reflect.Type

func (GroupArray) ToGroupArrayOutput 

func (i GroupArray) ToGroupArrayOutput() GroupArrayOutput

func (GroupArray) ToGroupArrayOutputWithContext 

func (i GroupArray) ToGroupArrayOutputWithContext(ctx context.Context) GroupArrayOutput

type GroupArrayInput 

type GroupArrayInput interface {
	pulumi.Input

	ToGroupArrayOutput() GroupArrayOutput
	ToGroupArrayOutputWithContext(context.Context) GroupArrayOutput
}

GroupArrayInput is an input type that accepts GroupArray and GroupArrayOutput values. You can construct a concrete instance of `GroupArrayInput` via: 

GroupArray{ GroupArgs{...} }

type GroupArrayOutput 

type GroupArrayOutput struct{ *pulumi.OutputState }

func (GroupArrayOutput) ElementType 

func (GroupArrayOutput) ElementType() reflect.Type

func (GroupArrayOutput) Index 

func (o GroupArrayOutput) Index(i pulumi.IntInput) GroupOutput

func (GroupArrayOutput) ToGroupArrayOutput 

func (o GroupArrayOutput) ToGroupArrayOutput() GroupArrayOutput

func (GroupArrayOutput) ToGroupArrayOutputWithContext 

func (o GroupArrayOutput) ToGroupArrayOutputWithContext(ctx context.Context) GroupArrayOutput

type GroupInput 

type GroupInput interface {
	pulumi.Input

	ToGroupOutput() GroupOutput
	ToGroupOutputWithContext(ctx context.Context) GroupOutput
}

type GroupMap 

type GroupMap map[string]GroupInput

func (GroupMap) ElementType 

func (GroupMap) ElementType() reflect.Type

func (GroupMap) ToGroupMapOutput 

func (i GroupMap) ToGroupMapOutput() GroupMapOutput

func (GroupMap) ToGroupMapOutputWithContext 

func (i GroupMap) ToGroupMapOutputWithContext(ctx context.Context) GroupMapOutput

type GroupMapInput 

type GroupMapInput interface {
	pulumi.Input

	ToGroupMapOutput() GroupMapOutput
	ToGroupMapOutputWithContext(context.Context) GroupMapOutput
}

GroupMapInput is an input type that accepts GroupMap and GroupMapOutput values. You can construct a concrete instance of `GroupMapInput` via: 

GroupMap{ "key": GroupArgs{...} }

type GroupMapOutput 

type GroupMapOutput struct{ *pulumi.OutputState }

func (GroupMapOutput) ElementType 

func (GroupMapOutput) ElementType() reflect.Type

func (GroupMapOutput) MapIndex 

func (o GroupMapOutput) MapIndex(k pulumi.StringInput) GroupOutput

func (GroupMapOutput) ToGroupMapOutput 

func (o GroupMapOutput) ToGroupMapOutput() GroupMapOutput

func (GroupMapOutput) ToGroupMapOutputWithContext 

func (o GroupMapOutput) ToGroupMapOutputWithContext(ctx context.Context) GroupMapOutput

type GroupOutput 

type GroupOutput struct{ *pulumi.OutputState }

func (GroupOutput) Description 

func (o GroupOutput) Description() pulumi.StringPtrOutput

Defaults to `""`.

func (GroupOutput) ElementType 

func (GroupOutput) ElementType() reflect.Type

func (GroupOutput) Name 

func (o GroupOutput) Name() pulumi.StringOutput

func (GroupOutput) ToGroupOutput 

func (o GroupOutput) ToGroupOutput() GroupOutput

func (GroupOutput) ToGroupOutputWithContext 

func (o GroupOutput) ToGroupOutputWithContext(ctx context.Context) GroupOutput

type GroupState 

type GroupState struct {
	// Defaults to `""`.
	Description pulumi.StringPtrInput
	Name        pulumi.StringPtrInput
}

func (GroupState) ElementType 

func (GroupState) ElementType() reflect.Type

type Permission 

type Permission struct {
	pulumi.CustomResourceState

	// A list actions that are allowed on the object types. Acceptable values are `view`, `add`, `change`, or `delete`.
	Actions pulumi.StringArrayOutput `pulumi:"actions"`
	// A JSON string of an arbitrary filter used to limit the granted action(s) to a specific subset of objects. For more information on correct syntax, see https://docs.netbox.dev/en/stable/administration/permissions/#constraints.
	Constraints pulumi.StringPtrOutput `pulumi:"constraints"`
	// The description of the permission object.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// Whether the permission object is enabled or not. Defaults to `true`.
	Enabled pulumi.BoolPtrOutput `pulumi:"enabled"`
	// A list of group IDs that have been assigned to this permission object.
	Groups pulumi.IntArrayOutput `pulumi:"groups"`
	// The name of the permission object.
	Name pulumi.StringOutput `pulumi:"name"`
	// A list of object types that the permission object allows access to. Should be in a form the API can accept. For example: `circuits.provider`, `dcim.inventoryitem`, etc.
	ObjectTypes pulumi.StringArrayOutput `pulumi:"objectTypes"`
	// A list of user IDs that have been assigned to this permission object.
	Users pulumi.IntArrayOutput `pulumi:"users"`
}

This resource manages the object-based permissions for Netbox users, built into the application.

> Object-based permissions enable an administrator to grant users or groups the ability to perform an action on arbitrary subsets of objects in NetBox, rather than all objects of a certain type. For more information, see the [Netbox Object-Based Permissions Docs.](https://docs.netbox.dev/en/stable/administration/permissions/)

## Example Usage

```go package main

import ( 

"encoding/json"

"github.com/NatzkaLabsOpenSource/pulumi-netbox/sdk/go/netbox/auth"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		test, err := auth.NewUser(ctx, "test", &auth.UserArgs{
			Username: pulumi.String("johndoe"),
			Password: pulumi.String("Abcdefghijkl1"),
			Active:   pulumi.Bool(true),
			Staff:    pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		tmpJSON0, err := json.Marshal([]map[string]interface{}{
			map[string]interface{}{
				"status": "active",
			},
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = auth.NewPermission(ctx, "test", &auth.PermissionArgs{
			Name:        pulumi.String("test"),
			Description: pulumi.String("my description"),
			Enabled:     pulumi.Bool(true),
			ObjectTypes: pulumi.StringArray{
				pulumi.String("ipam.prefix"),
			},
			Actions: pulumi.StringArray{
				pulumi.String("add"),
				pulumi.String("change"),
			},
			Users: pulumi.IntArray{
				test.ID(),
			},
			Constraints: pulumi.String(json0),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetPermission 

func GetPermission(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *PermissionState, opts ...pulumi.ResourceOption) (*Permission, error)

GetPermission gets an existing Permission resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewPermission 

func NewPermission(ctx *pulumi.Context,
	name string, args *PermissionArgs, opts ...pulumi.ResourceOption) (*Permission, error)

NewPermission registers a new resource with the given unique name, arguments, and options.

func (*Permission) ElementType 

func (*Permission) ElementType() reflect.Type

func (*Permission) ToPermissionOutput 

func (i *Permission) ToPermissionOutput() PermissionOutput

func (*Permission) ToPermissionOutputWithContext 

func (i *Permission) ToPermissionOutputWithContext(ctx context.Context) PermissionOutput

type PermissionArgs 

type PermissionArgs struct {
	// A list actions that are allowed on the object types. Acceptable values are `view`, `add`, `change`, or `delete`.
	Actions pulumi.StringArrayInput
	// A JSON string of an arbitrary filter used to limit the granted action(s) to a specific subset of objects. For more information on correct syntax, see https://docs.netbox.dev/en/stable/administration/permissions/#constraints.
	Constraints pulumi.StringPtrInput
	// The description of the permission object.
	Description pulumi.StringPtrInput
	// Whether the permission object is enabled or not. Defaults to `true`.
	Enabled pulumi.BoolPtrInput
	// A list of group IDs that have been assigned to this permission object.
	Groups pulumi.IntArrayInput
	// The name of the permission object.
	Name pulumi.StringPtrInput
	// A list of object types that the permission object allows access to. Should be in a form the API can accept. For example: `circuits.provider`, `dcim.inventoryitem`, etc.
	ObjectTypes pulumi.StringArrayInput
	// A list of user IDs that have been assigned to this permission object.
	Users pulumi.IntArrayInput
}

The set of arguments for constructing a Permission resource.

func (PermissionArgs) ElementType 

func (PermissionArgs) ElementType() reflect.Type

type PermissionArray 

type PermissionArray []PermissionInput

func (PermissionArray) ElementType 

func (PermissionArray) ElementType() reflect.Type

func (PermissionArray) ToPermissionArrayOutput 

func (i PermissionArray) ToPermissionArrayOutput() PermissionArrayOutput

func (PermissionArray) ToPermissionArrayOutputWithContext 

func (i PermissionArray) ToPermissionArrayOutputWithContext(ctx context.Context) PermissionArrayOutput

type PermissionArrayInput 

type PermissionArrayInput interface {
	pulumi.Input

	ToPermissionArrayOutput() PermissionArrayOutput
	ToPermissionArrayOutputWithContext(context.Context) PermissionArrayOutput
}

PermissionArrayInput is an input type that accepts PermissionArray and PermissionArrayOutput values. You can construct a concrete instance of `PermissionArrayInput` via: 

PermissionArray{ PermissionArgs{...} }

type PermissionArrayOutput 

type PermissionArrayOutput struct{ *pulumi.OutputState }

func (PermissionArrayOutput) ElementType 

func (PermissionArrayOutput) ElementType() reflect.Type

func (PermissionArrayOutput) Index 

func (o PermissionArrayOutput) Index(i pulumi.IntInput) PermissionOutput

func (PermissionArrayOutput) ToPermissionArrayOutput 

func (o PermissionArrayOutput) ToPermissionArrayOutput() PermissionArrayOutput

func (PermissionArrayOutput) ToPermissionArrayOutputWithContext 

func (o PermissionArrayOutput) ToPermissionArrayOutputWithContext(ctx context.Context) PermissionArrayOutput

type PermissionInput 

type PermissionInput interface {
	pulumi.Input

	ToPermissionOutput() PermissionOutput
	ToPermissionOutputWithContext(ctx context.Context) PermissionOutput
}

type PermissionMap 

type PermissionMap map[string]PermissionInput

func (PermissionMap) ElementType 

func (PermissionMap) ElementType() reflect.Type

func (PermissionMap) ToPermissionMapOutput 

func (i PermissionMap) ToPermissionMapOutput() PermissionMapOutput

func (PermissionMap) ToPermissionMapOutputWithContext 

func (i PermissionMap) ToPermissionMapOutputWithContext(ctx context.Context) PermissionMapOutput

type PermissionMapInput 

type PermissionMapInput interface {
	pulumi.Input

	ToPermissionMapOutput() PermissionMapOutput
	ToPermissionMapOutputWithContext(context.Context) PermissionMapOutput
}

PermissionMapInput is an input type that accepts PermissionMap and PermissionMapOutput values. You can construct a concrete instance of `PermissionMapInput` via: 

PermissionMap{ "key": PermissionArgs{...} }

type PermissionMapOutput 

type PermissionMapOutput struct{ *pulumi.OutputState }

func (PermissionMapOutput) ElementType 

func (PermissionMapOutput) ElementType() reflect.Type

func (PermissionMapOutput) MapIndex 

func (o PermissionMapOutput) MapIndex(k pulumi.StringInput) PermissionOutput

func (PermissionMapOutput) ToPermissionMapOutput 

func (o PermissionMapOutput) ToPermissionMapOutput() PermissionMapOutput

func (PermissionMapOutput) ToPermissionMapOutputWithContext 

func (o PermissionMapOutput) ToPermissionMapOutputWithContext(ctx context.Context) PermissionMapOutput

type PermissionOutput 

type PermissionOutput struct{ *pulumi.OutputState }

func (PermissionOutput) Actions 

func (o PermissionOutput) Actions() pulumi.StringArrayOutput

A list actions that are allowed on the object types. Acceptable values are `view`, `add`, `change`, or `delete`.

func (PermissionOutput) Constraints 

func (o PermissionOutput) Constraints() pulumi.StringPtrOutput

A JSON string of an arbitrary filter used to limit the granted action(s) to a specific subset of objects. For more information on correct syntax, see https://docs.netbox.dev/en/stable/administration/permissions/#constraints.

func (PermissionOutput) Description 

func (o PermissionOutput) Description() pulumi.StringPtrOutput

The description of the permission object.

func (PermissionOutput) ElementType 

func (PermissionOutput) ElementType() reflect.Type

func (PermissionOutput) Enabled 

func (o PermissionOutput) Enabled() pulumi.BoolPtrOutput

Whether the permission object is enabled or not. Defaults to `true`.

func (PermissionOutput) Groups 

func (o PermissionOutput) Groups() pulumi.IntArrayOutput

A list of group IDs that have been assigned to this permission object.

func (PermissionOutput) Name 

func (o PermissionOutput) Name() pulumi.StringOutput

The name of the permission object.

func (PermissionOutput) ObjectTypes 

func (o PermissionOutput) ObjectTypes() pulumi.StringArrayOutput

A list of object types that the permission object allows access to. Should be in a form the API can accept. For example: `circuits.provider`, `dcim.inventoryitem`, etc.

func (PermissionOutput) ToPermissionOutput 

func (o PermissionOutput) ToPermissionOutput() PermissionOutput

func (PermissionOutput) ToPermissionOutputWithContext 

func (o PermissionOutput) ToPermissionOutputWithContext(ctx context.Context) PermissionOutput

func (PermissionOutput) Users 

func (o PermissionOutput) Users() pulumi.IntArrayOutput

A list of user IDs that have been assigned to this permission object.

type PermissionState 

type PermissionState struct {
	// A list actions that are allowed on the object types. Acceptable values are `view`, `add`, `change`, or `delete`.
	Actions pulumi.StringArrayInput
	// A JSON string of an arbitrary filter used to limit the granted action(s) to a specific subset of objects. For more information on correct syntax, see https://docs.netbox.dev/en/stable/administration/permissions/#constraints.
	Constraints pulumi.StringPtrInput
	// The description of the permission object.
	Description pulumi.StringPtrInput
	// Whether the permission object is enabled or not. Defaults to `true`.
	Enabled pulumi.BoolPtrInput
	// A list of group IDs that have been assigned to this permission object.
	Groups pulumi.IntArrayInput
	// The name of the permission object.
	Name pulumi.StringPtrInput
	// A list of object types that the permission object allows access to. Should be in a form the API can accept. For example: `circuits.provider`, `dcim.inventoryitem`, etc.
	ObjectTypes pulumi.StringArrayInput
	// A list of user IDs that have been assigned to this permission object.
	Users pulumi.IntArrayInput
}

func (PermissionState) ElementType 

func (PermissionState) ElementType() reflect.Type

type Token 

type Token struct {
	pulumi.CustomResourceState

	AllowedIps   pulumi.StringArrayOutput `pulumi:"allowedIps"`
	Description  pulumi.StringPtrOutput   `pulumi:"description"`
	Expires      pulumi.StringOutput      `pulumi:"expires"`
	Key          pulumi.StringPtrOutput   `pulumi:"key"`
	LastUsed     pulumi.StringOutput      `pulumi:"lastUsed"`
	UserId       pulumi.IntOutput         `pulumi:"userId"`
	WriteEnabled pulumi.BoolPtrOutput     `pulumi:"writeEnabled"`
}

From the [official documentation](https://docs.netbox.dev/en/stable/rest-api/authentication/#tokens):

> A token is a unique identifier mapped to a NetBox user account. Each user may have one or more tokens which he or she can use for authentication when making REST API requests. To create a token, navigate to the API tokens page under your user profile.

## Example Usage

```go package main

import ( 

"github.com/NatzkaLabsOpenSource/pulumi-netbox/sdk/go/netbox/auth"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		test, err := auth.NewUser(ctx, "test", &auth.UserArgs{
			Username: pulumi.String("johndoe"),
			Password: pulumi.String("Abcdefghijkl1"),
		})
		if err != nil {
			return err
		}
		_, err = auth.NewToken(ctx, "test_basic", &auth.TokenArgs{
			UserId: test.ID(),
			Key:    pulumi.String("0123456789012345678901234567890123456789"),
			AllowedIps: pulumi.StringArray{
				pulumi.String("2.4.8.16/32"),
			},
			WriteEnabled: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetToken 

func GetToken(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *TokenState, opts ...pulumi.ResourceOption) (*Token, error)

GetToken gets an existing Token resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewToken 

func NewToken(ctx *pulumi.Context,
	name string, args *TokenArgs, opts ...pulumi.ResourceOption) (*Token, error)

NewToken registers a new resource with the given unique name, arguments, and options.

func (*Token) ElementType 

func (*Token) ElementType() reflect.Type

func (*Token) ToTokenOutput 

func (i *Token) ToTokenOutput() TokenOutput

func (*Token) ToTokenOutputWithContext 

func (i *Token) ToTokenOutputWithContext(ctx context.Context) TokenOutput

type TokenArgs 

type TokenArgs struct {
	AllowedIps   pulumi.StringArrayInput
	Description  pulumi.StringPtrInput
	Key          pulumi.StringPtrInput
	UserId       pulumi.IntInput
	WriteEnabled pulumi.BoolPtrInput
}

The set of arguments for constructing a Token resource.

func (TokenArgs) ElementType 

func (TokenArgs) ElementType() reflect.Type

type TokenArray 

type TokenArray []TokenInput

func (TokenArray) ElementType 

func (TokenArray) ElementType() reflect.Type

func (TokenArray) ToTokenArrayOutput 

func (i TokenArray) ToTokenArrayOutput() TokenArrayOutput

func (TokenArray) ToTokenArrayOutputWithContext 

func (i TokenArray) ToTokenArrayOutputWithContext(ctx context.Context) TokenArrayOutput

type TokenArrayInput 

type TokenArrayInput interface {
	pulumi.Input

	ToTokenArrayOutput() TokenArrayOutput
	ToTokenArrayOutputWithContext(context.Context) TokenArrayOutput
}

TokenArrayInput is an input type that accepts TokenArray and TokenArrayOutput values. You can construct a concrete instance of `TokenArrayInput` via: 

TokenArray{ TokenArgs{...} }

type TokenArrayOutput 

type TokenArrayOutput struct{ *pulumi.OutputState }

func (TokenArrayOutput) ElementType 

func (TokenArrayOutput) ElementType() reflect.Type

func (TokenArrayOutput) Index 

func (o TokenArrayOutput) Index(i pulumi.IntInput) TokenOutput

func (TokenArrayOutput) ToTokenArrayOutput 

func (o TokenArrayOutput) ToTokenArrayOutput() TokenArrayOutput

func (TokenArrayOutput) ToTokenArrayOutputWithContext 

func (o TokenArrayOutput) ToTokenArrayOutputWithContext(ctx context.Context) TokenArrayOutput

type TokenInput 

type TokenInput interface {
	pulumi.Input

	ToTokenOutput() TokenOutput
	ToTokenOutputWithContext(ctx context.Context) TokenOutput
}

type TokenMap 

type TokenMap map[string]TokenInput

func (TokenMap) ElementType 

func (TokenMap) ElementType() reflect.Type

func (TokenMap) ToTokenMapOutput 

func (i TokenMap) ToTokenMapOutput() TokenMapOutput

func (TokenMap) ToTokenMapOutputWithContext 

func (i TokenMap) ToTokenMapOutputWithContext(ctx context.Context) TokenMapOutput

type TokenMapInput 

type TokenMapInput interface {
	pulumi.Input

	ToTokenMapOutput() TokenMapOutput
	ToTokenMapOutputWithContext(context.Context) TokenMapOutput
}

TokenMapInput is an input type that accepts TokenMap and TokenMapOutput values. You can construct a concrete instance of `TokenMapInput` via: 

TokenMap{ "key": TokenArgs{...} }

type TokenMapOutput 

type TokenMapOutput struct{ *pulumi.OutputState }

func (TokenMapOutput) ElementType 

func (TokenMapOutput) ElementType() reflect.Type

func (TokenMapOutput) MapIndex 

func (o TokenMapOutput) MapIndex(k pulumi.StringInput) TokenOutput

func (TokenMapOutput) ToTokenMapOutput 

func (o TokenMapOutput) ToTokenMapOutput() TokenMapOutput

func (TokenMapOutput) ToTokenMapOutputWithContext 

func (o TokenMapOutput) ToTokenMapOutputWithContext(ctx context.Context) TokenMapOutput

type TokenOutput 

type TokenOutput struct{ *pulumi.OutputState }

func (TokenOutput) AllowedIps 

func (o TokenOutput) AllowedIps() pulumi.StringArrayOutput

func (TokenOutput) Description 

func (o TokenOutput) Description() pulumi.StringPtrOutput

func (TokenOutput) ElementType 

func (TokenOutput) ElementType() reflect.Type

func (TokenOutput) Expires 

func (o TokenOutput) Expires() pulumi.StringOutput

func (TokenOutput) Key 

func (o TokenOutput) Key() pulumi.StringPtrOutput

func (TokenOutput) LastUsed 

func (o TokenOutput) LastUsed() pulumi.StringOutput

func (TokenOutput) ToTokenOutput 

func (o TokenOutput) ToTokenOutput() TokenOutput

func (TokenOutput) ToTokenOutputWithContext 

func (o TokenOutput) ToTokenOutputWithContext(ctx context.Context) TokenOutput

func (TokenOutput) UserId 

func (o TokenOutput) UserId() pulumi.IntOutput

func (TokenOutput) WriteEnabled 

func (o TokenOutput) WriteEnabled() pulumi.BoolPtrOutput

type TokenState 

type TokenState struct {
	AllowedIps   pulumi.StringArrayInput
	Description  pulumi.StringPtrInput
	Expires      pulumi.StringPtrInput
	Key          pulumi.StringPtrInput
	LastUsed     pulumi.StringPtrInput
	UserId       pulumi.IntPtrInput
	WriteEnabled pulumi.BoolPtrInput
}

func (TokenState) ElementType 

func (TokenState) ElementType() reflect.Type

type User 

type User struct {
	pulumi.CustomResourceState

	// Defaults to `true`.
	Active pulumi.BoolPtrOutput `pulumi:"active"`
	// Defaults to `""`.
	Email pulumi.StringPtrOutput `pulumi:"email"`
	// Defaults to `""`.
	FirstName pulumi.StringPtrOutput `pulumi:"firstName"`
	GroupIds  pulumi.IntArrayOutput  `pulumi:"groupIds"`
	// Defaults to `""`.
	LastName pulumi.StringPtrOutput `pulumi:"lastName"`
	Password pulumi.StringOutput    `pulumi:"password"`
	// Defaults to `false`.
	Staff    pulumi.BoolPtrOutput `pulumi:"staff"`
	Username pulumi.StringOutput  `pulumi:"username"`
}

This resource is used to manage users.

## Example Usage

```go package main

import ( 

"github.com/NatzkaLabsOpenSource/pulumi-netbox/sdk/go/netbox/auth"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := auth.NewUser(ctx, "test", &auth.UserArgs{
			Username: pulumi.String("johndoe"),
			Password: pulumi.String("Abcdefghijkl1"),
			Active:   pulumi.Bool(true),
			Staff:    pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetUser 

func GetUser(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *UserState, opts ...pulumi.ResourceOption) (*User, error)

GetUser gets an existing User resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewUser 

func NewUser(ctx *pulumi.Context,
	name string, args *UserArgs, opts ...pulumi.ResourceOption) (*User, error)

NewUser registers a new resource with the given unique name, arguments, and options.

func (*User) ElementType 

func (*User) ElementType() reflect.Type

func (*User) ToUserOutput 

func (i *User) ToUserOutput() UserOutput

func (*User) ToUserOutputWithContext 

func (i *User) ToUserOutputWithContext(ctx context.Context) UserOutput

type UserArgs 

type UserArgs struct {
	// Defaults to `true`.
	Active pulumi.BoolPtrInput
	// Defaults to `""`.
	Email pulumi.StringPtrInput
	// Defaults to `""`.
	FirstName pulumi.StringPtrInput
	GroupIds  pulumi.IntArrayInput
	// Defaults to `""`.
	LastName pulumi.StringPtrInput
	Password pulumi.StringInput
	// Defaults to `false`.
	Staff    pulumi.BoolPtrInput
	Username pulumi.StringInput
}

The set of arguments for constructing a User resource.

func (UserArgs) ElementType 

func (UserArgs) ElementType() reflect.Type

type UserArray 

type UserArray []UserInput

func (UserArray) ElementType 

func (UserArray) ElementType() reflect.Type

func (UserArray) ToUserArrayOutput 

func (i UserArray) ToUserArrayOutput() UserArrayOutput

func (UserArray) ToUserArrayOutputWithContext 

func (i UserArray) ToUserArrayOutputWithContext(ctx context.Context) UserArrayOutput

type UserArrayInput 

type UserArrayInput interface {
	pulumi.Input

	ToUserArrayOutput() UserArrayOutput
	ToUserArrayOutputWithContext(context.Context) UserArrayOutput
}

UserArrayInput is an input type that accepts UserArray and UserArrayOutput values. You can construct a concrete instance of `UserArrayInput` via: 

UserArray{ UserArgs{...} }

type UserArrayOutput 

type UserArrayOutput struct{ *pulumi.OutputState }

func (UserArrayOutput) ElementType 

func (UserArrayOutput) ElementType() reflect.Type

func (UserArrayOutput) Index 

func (o UserArrayOutput) Index(i pulumi.IntInput) UserOutput

func (UserArrayOutput) ToUserArrayOutput 

func (o UserArrayOutput) ToUserArrayOutput() UserArrayOutput

func (UserArrayOutput) ToUserArrayOutputWithContext 

func (o UserArrayOutput) ToUserArrayOutputWithContext(ctx context.Context) UserArrayOutput

type UserInput 

type UserInput interface {
	pulumi.Input

	ToUserOutput() UserOutput
	ToUserOutputWithContext(ctx context.Context) UserOutput
}

type UserMap 

type UserMap map[string]UserInput

func (UserMap) ElementType 

func (UserMap) ElementType() reflect.Type

func (UserMap) ToUserMapOutput 

func (i UserMap) ToUserMapOutput() UserMapOutput

func (UserMap) ToUserMapOutputWithContext 

func (i UserMap) ToUserMapOutputWithContext(ctx context.Context) UserMapOutput

type UserMapInput 

type UserMapInput interface {
	pulumi.Input

	ToUserMapOutput() UserMapOutput
	ToUserMapOutputWithContext(context.Context) UserMapOutput
}

UserMapInput is an input type that accepts UserMap and UserMapOutput values. You can construct a concrete instance of `UserMapInput` via: 

UserMap{ "key": UserArgs{...} }

type UserMapOutput 

type UserMapOutput struct{ *pulumi.OutputState }

func (UserMapOutput) ElementType 

func (UserMapOutput) ElementType() reflect.Type

func (UserMapOutput) MapIndex 

func (o UserMapOutput) MapIndex(k pulumi.StringInput) UserOutput

func (UserMapOutput) ToUserMapOutput 

func (o UserMapOutput) ToUserMapOutput() UserMapOutput

func (UserMapOutput) ToUserMapOutputWithContext 

func (o UserMapOutput) ToUserMapOutputWithContext(ctx context.Context) UserMapOutput

type UserOutput 

type UserOutput struct{ *pulumi.OutputState }

func (UserOutput) Active 

func (o UserOutput) Active() pulumi.BoolPtrOutput

Defaults to `true`.

func (UserOutput) ElementType 

func (UserOutput) ElementType() reflect.Type

func (UserOutput) Email 

func (o UserOutput) Email() pulumi.StringPtrOutput

Defaults to `""`.

func (UserOutput) FirstName 

func (o UserOutput) FirstName() pulumi.StringPtrOutput

Defaults to `""`.

func (UserOutput) GroupIds 

func (o UserOutput) GroupIds() pulumi.IntArrayOutput

func (UserOutput) LastName 

func (o UserOutput) LastName() pulumi.StringPtrOutput

Defaults to `""`.

func (UserOutput) Password 

func (o UserOutput) Password() pulumi.StringOutput

func (UserOutput) Staff 

func (o UserOutput) Staff() pulumi.BoolPtrOutput

Defaults to `false`.

func (UserOutput) ToUserOutput 

func (o UserOutput) ToUserOutput() UserOutput

func (UserOutput) ToUserOutputWithContext 

func (o UserOutput) ToUserOutputWithContext(ctx context.Context) UserOutput

func (UserOutput) Username 

func (o UserOutput) Username() pulumi.StringOutput

type UserState 

type UserState struct {
	// Defaults to `true`.
	Active pulumi.BoolPtrInput
	// Defaults to `""`.
	Email pulumi.StringPtrInput
	// Defaults to `""`.
	FirstName pulumi.StringPtrInput
	GroupIds  pulumi.IntArrayInput
	// Defaults to `""`.
	LastName pulumi.StringPtrInput
	Password pulumi.StringPtrInput
	// Defaults to `false`.
	Staff    pulumi.BoolPtrInput
	Username pulumi.StringPtrInput
}

func (UserState) ElementType 

func (UserState) ElementType() reflect.Type

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.