@osmit-gmbh/pulumi-authentik
Version:
A Pulumi package for creating and managing authentik cloud resources.
101 lines (100 loc) • 3.3 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as authentik from "@osmit-gmbh/pulumi-authentik";
*
* // Create a super-user group with a user
* const name = new authentik.User("name", {
* username: "user",
* name: "User",
* });
* const group = new authentik.Group("group", {
* name: "tf_admins",
* users: [name.id],
* isSuperuser: true,
* });
* ```
*/
export declare class Group extends pulumi.CustomResource {
/**
* Get an existing Group resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: GroupState, opts?: pulumi.CustomResourceOptions): Group;
/**
* Returns true if the given object is an instance of Group. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Group;
/**
* JSON format expected. Use jsonencode() to pass objects. Defaults to `{}`.
*/
readonly attributes: pulumi.Output<string | undefined>;
/**
* Defaults to `false`.
*/
readonly isSuperuser: pulumi.Output<boolean | undefined>;
readonly name: pulumi.Output<string>;
readonly parent: pulumi.Output<string | undefined>;
readonly roles: pulumi.Output<string[] | undefined>;
/**
* Generated.
*/
readonly users: pulumi.Output<number[]>;
/**
* Create a Group resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: GroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Group resources.
*/
export interface GroupState {
/**
* JSON format expected. Use jsonencode() to pass objects. Defaults to `{}`.
*/
attributes?: pulumi.Input<string>;
/**
* Defaults to `false`.
*/
isSuperuser?: pulumi.Input<boolean>;
name?: pulumi.Input<string>;
parent?: pulumi.Input<string>;
roles?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Generated.
*/
users?: pulumi.Input<pulumi.Input<number>[]>;
}
/**
* The set of arguments for constructing a Group resource.
*/
export interface GroupArgs {
/**
* JSON format expected. Use jsonencode() to pass objects. Defaults to `{}`.
*/
attributes?: pulumi.Input<string>;
/**
* Defaults to `false`.
*/
isSuperuser?: pulumi.Input<boolean>;
name?: pulumi.Input<string>;
parent?: pulumi.Input<string>;
roles?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Generated.
*/
users?: pulumi.Input<pulumi.Input<number>[]>;
}