@osmit-gmbh/pulumi-authentik
Version:
A Pulumi package for creating and managing authentik cloud resources.
128 lines (127 loc) • 5.07 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";
* import * as authentik from "@pulumi/authentik";
*
* // Create a plex source
* const default-authorization-flow = authentik.getFlow({
* slug: "default-provider-authorization-implicit-consent",
* });
* const name = new authentik.SourcePlex("name", {
* name: "plex",
* slug: "plex",
* authenticationFlow: default_authorization_flow.then(default_authorization_flow => default_authorization_flow.id),
* enrollmentFlow: default_authorization_flow.then(default_authorization_flow => default_authorization_flow.id),
* clientId: "foo-bar-baz",
* plexToken: "foo",
* });
* ```
*/
export declare class SourcePlex extends pulumi.CustomResource {
/**
* Get an existing SourcePlex 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?: SourcePlexState, opts?: pulumi.CustomResourceOptions): SourcePlex;
/**
* Returns true if the given object is an instance of SourcePlex. 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 SourcePlex;
readonly allowFriends: pulumi.Output<boolean | undefined>;
readonly allowedServers: pulumi.Output<string[] | undefined>;
readonly authenticationFlow: pulumi.Output<string | undefined>;
readonly clientId: pulumi.Output<string>;
readonly enabled: pulumi.Output<boolean | undefined>;
readonly enrollmentFlow: pulumi.Output<string | undefined>;
/**
* Allowed values: - `identifier` - `nameLink` - `nameDeny`
*/
readonly groupMatchingMode: pulumi.Output<string | undefined>;
readonly name: pulumi.Output<string>;
readonly plexToken: pulumi.Output<string>;
/**
* Allowed values: - `all` - `any`
*/
readonly policyEngineMode: pulumi.Output<string | undefined>;
readonly slug: pulumi.Output<string>;
/**
* Allowed values: - `identifier` - `emailLink` - `emailDeny` - `usernameLink` - `usernameDeny`
*/
readonly userMatchingMode: pulumi.Output<string | undefined>;
readonly userPathTemplate: pulumi.Output<string | undefined>;
readonly uuid: pulumi.Output<string>;
/**
* Create a SourcePlex 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: SourcePlexArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering SourcePlex resources.
*/
export interface SourcePlexState {
allowFriends?: pulumi.Input<boolean>;
allowedServers?: pulumi.Input<pulumi.Input<string>[]>;
authenticationFlow?: pulumi.Input<string>;
clientId?: pulumi.Input<string>;
enabled?: pulumi.Input<boolean>;
enrollmentFlow?: pulumi.Input<string>;
/**
* Allowed values: - `identifier` - `nameLink` - `nameDeny`
*/
groupMatchingMode?: pulumi.Input<string>;
name?: pulumi.Input<string>;
plexToken?: pulumi.Input<string>;
/**
* Allowed values: - `all` - `any`
*/
policyEngineMode?: pulumi.Input<string>;
slug?: pulumi.Input<string>;
/**
* Allowed values: - `identifier` - `emailLink` - `emailDeny` - `usernameLink` - `usernameDeny`
*/
userMatchingMode?: pulumi.Input<string>;
userPathTemplate?: pulumi.Input<string>;
uuid?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a SourcePlex resource.
*/
export interface SourcePlexArgs {
allowFriends?: pulumi.Input<boolean>;
allowedServers?: pulumi.Input<pulumi.Input<string>[]>;
authenticationFlow?: pulumi.Input<string>;
clientId: pulumi.Input<string>;
enabled?: pulumi.Input<boolean>;
enrollmentFlow?: pulumi.Input<string>;
/**
* Allowed values: - `identifier` - `nameLink` - `nameDeny`
*/
groupMatchingMode?: pulumi.Input<string>;
name?: pulumi.Input<string>;
plexToken: pulumi.Input<string>;
/**
* Allowed values: - `all` - `any`
*/
policyEngineMode?: pulumi.Input<string>;
slug: pulumi.Input<string>;
/**
* Allowed values: - `identifier` - `emailLink` - `emailDeny` - `usernameLink` - `usernameDeny`
*/
userMatchingMode?: pulumi.Input<string>;
userPathTemplate?: pulumi.Input<string>;
uuid?: pulumi.Input<string>;
}