@osmit-gmbh/pulumi-authentik
Version:
A Pulumi package for creating and managing authentik cloud resources.
91 lines (90 loc) • 2.06 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "./types/output";
/**
* Get groups by pk or name
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as authentik from "@pulumi/authentik";
*
* // To get the ID of a group by name
* const admins = authentik.getGroup({
* name: "authentik Admins",
* });
* ```
*/
export declare function getGroup(args?: GetGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetGroupResult>;
/**
* A collection of arguments for invoking getGroup.
*/
export interface GetGroupArgs {
includeUsers?: boolean;
name?: string;
pk?: string;
}
/**
* A collection of values returned by getGroup.
*/
export interface GetGroupResult {
/**
* Generated.
*/
readonly attributes: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly includeUsers?: boolean;
/**
* Generated.
*/
readonly isSuperuser: boolean;
readonly name?: string;
/**
* Generated.
*/
readonly numPk: number;
/**
* Generated.
*/
readonly parent: string;
/**
* Generated.
*/
readonly parentName: string;
readonly pk?: string;
/**
* Generated.
*/
readonly users: number[];
/**
* Generated.
*/
readonly usersObjs: outputs.GetGroupUsersObj[];
}
/**
* Get groups by pk or name
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as authentik from "@pulumi/authentik";
*
* // To get the ID of a group by name
* const admins = authentik.getGroup({
* name: "authentik Admins",
* });
* ```
*/
export declare function getGroupOutput(args?: GetGroupOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetGroupResult>;
/**
* A collection of arguments for invoking getGroup.
*/
export interface GetGroupOutputArgs {
includeUsers?: pulumi.Input<boolean>;
name?: pulumi.Input<string>;
pk?: pulumi.Input<string>;
}