@ctfer-io/pulumi-ctfd
Version:
The CTFd provider for Pulumi, to manage its resources as code.
199 lines (198 loc) • 6.12 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* CTFd defines a User as someone who will either play or administrate the Capture The Flag event.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as ctfd from "@ctfer-io/pulumi-ctfd";
*
* const ctfer = new ctfd.User("ctfer", {
* email: "ctfer-io@protonmail.com",
* hidden: true,
* password: "password",
* type: "admin",
* verified: true,
* });
* ```
*/
export declare class User extends pulumi.CustomResource {
/**
* Get an existing User 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?: UserState, opts?: pulumi.CustomResourceOptions): User;
/**
* Returns true if the given object is an instance of User. 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 User;
/**
* Affiliation to a team, company or agency.
*/
readonly affiliation: pulumi.Output<string | undefined>;
/**
* Is true if the user is banned from the CTF.
*/
readonly banned: pulumi.Output<boolean>;
/**
* The bracket id the user plays in.
*/
readonly bracketId: pulumi.Output<string | undefined>;
/**
* Country the user represent or is native from.
*/
readonly country: pulumi.Output<string | undefined>;
/**
* Email of the user, may be used to verify the account.
*/
readonly email: pulumi.Output<string>;
/**
* Is true if the user is hidden to the participants.
*/
readonly hidden: pulumi.Output<boolean>;
/**
* Language the user is fluent in.
*/
readonly language: pulumi.Output<string | undefined>;
/**
* Name or pseudo of the user.
*/
readonly name: pulumi.Output<string>;
/**
* Password of the user. Notice than during a CTF you may not want to update those to avoid defaulting user accesses.
*/
readonly password: pulumi.Output<string>;
/**
* Generic type for RBAC purposes.
*/
readonly type: pulumi.Output<string>;
/**
* Is true if the user has verified its account by email, or if set by an admin.
*/
readonly verified: pulumi.Output<boolean>;
/**
* Website, blog, or anything similar (displayed to other participants).
*/
readonly website: pulumi.Output<string | undefined>;
/**
* Create a User 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: UserArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering User resources.
*/
export interface UserState {
/**
* Affiliation to a team, company or agency.
*/
affiliation?: pulumi.Input<string>;
/**
* Is true if the user is banned from the CTF.
*/
banned?: pulumi.Input<boolean>;
/**
* The bracket id the user plays in.
*/
bracketId?: pulumi.Input<string>;
/**
* Country the user represent or is native from.
*/
country?: pulumi.Input<string>;
/**
* Email of the user, may be used to verify the account.
*/
email?: pulumi.Input<string>;
/**
* Is true if the user is hidden to the participants.
*/
hidden?: pulumi.Input<boolean>;
/**
* Language the user is fluent in.
*/
language?: pulumi.Input<string>;
/**
* Name or pseudo of the user.
*/
name?: pulumi.Input<string>;
/**
* Password of the user. Notice than during a CTF you may not want to update those to avoid defaulting user accesses.
*/
password?: pulumi.Input<string>;
/**
* Generic type for RBAC purposes.
*/
type?: pulumi.Input<string>;
/**
* Is true if the user has verified its account by email, or if set by an admin.
*/
verified?: pulumi.Input<boolean>;
/**
* Website, blog, or anything similar (displayed to other participants).
*/
website?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a User resource.
*/
export interface UserArgs {
/**
* Affiliation to a team, company or agency.
*/
affiliation?: pulumi.Input<string>;
/**
* Is true if the user is banned from the CTF.
*/
banned?: pulumi.Input<boolean>;
/**
* The bracket id the user plays in.
*/
bracketId?: pulumi.Input<string>;
/**
* Country the user represent or is native from.
*/
country?: pulumi.Input<string>;
/**
* Email of the user, may be used to verify the account.
*/
email: pulumi.Input<string>;
/**
* Is true if the user is hidden to the participants.
*/
hidden?: pulumi.Input<boolean>;
/**
* Language the user is fluent in.
*/
language?: pulumi.Input<string>;
/**
* Name or pseudo of the user.
*/
name?: pulumi.Input<string>;
/**
* Password of the user. Notice than during a CTF you may not want to update those to avoid defaulting user accesses.
*/
password: pulumi.Input<string>;
/**
* Generic type for RBAC purposes.
*/
type?: pulumi.Input<string>;
/**
* Is true if the user has verified its account by email, or if set by an admin.
*/
verified?: pulumi.Input<boolean>;
/**
* Website, blog, or anything similar (displayed to other participants).
*/
website?: pulumi.Input<string>;
}