UNPKG

@emailbob/twingate

Version:

A Pulumi package for creating and managing Twingate cloud resources.

83 lines (82 loc) 2.71 kB
import * as pulumi from "@pulumi/pulumi"; /** * Users in Twingate can be given access to Twingate Resources and may either be added manually or automatically synchronized with a 3rd party identity provider. For more information, see Twingate's [documentation](https://docs.twingate.com/docs/users). * * ## Example Usage * * <!--Start PulumiCodeChooser --> * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as twingate from "@pulumi/twingate"; * * const foo = twingate.getTwingateUser({ * id: "<your user's id>", * }); * ``` * <!--End PulumiCodeChooser --> */ export declare function getTwingateUser(args: GetTwingateUserArgs, opts?: pulumi.InvokeOptions): Promise<GetTwingateUserResult>; /** * A collection of arguments for invoking getTwingateUser. */ export interface GetTwingateUserArgs { /** * The ID of the User. The ID for the User can be obtained from the Admin API or the URL string in the Admin Console. */ id: string; } /** * A collection of values returned by getTwingateUser. */ export interface GetTwingateUserResult { /** * The email address of the User */ readonly email: string; /** * The first name of the User */ readonly firstName: string; /** * The ID of the User. The ID for the User can be obtained from the Admin API or the URL string in the Admin Console. */ readonly id: string; /** * The last name of the User */ readonly lastName: string; /** * Indicates the User's role. Either ADMIN, DEVOPS, SUPPORT, or MEMBER */ readonly role: string; /** * Indicates the User's type. Either MANUAL or SYNCED. */ readonly type: string; } /** * Users in Twingate can be given access to Twingate Resources and may either be added manually or automatically synchronized with a 3rd party identity provider. For more information, see Twingate's [documentation](https://docs.twingate.com/docs/users). * * ## Example Usage * * <!--Start PulumiCodeChooser --> * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as twingate from "@pulumi/twingate"; * * const foo = twingate.getTwingateUser({ * id: "<your user's id>", * }); * ``` * <!--End PulumiCodeChooser --> */ export declare function getTwingateUserOutput(args: GetTwingateUserOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetTwingateUserResult>; /** * A collection of arguments for invoking getTwingateUser. */ export interface GetTwingateUserOutputArgs { /** * The ID of the User. The ID for the User can be obtained from the Admin API or the URL string in the Admin Console. */ id: pulumi.Input<string>; }