@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
127 lines • 3.8 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Use this data source to get information on an existing IAM user based on its ID or email address.
* For more information refer to the [IAM API documentation](https://developers.scaleway.com/en/products/iam/api/v1alpha1/#users-06bdcf).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* // Get info by user id
* const findById = scaleway.iam.getUser({
* userId: "11111111-1111-1111-1111-111111111111",
* });
* // Get info by email address
* const findByEmail = scaleway.iam.getUser({
* email: "foo@bar.com",
* });
* ```
*/
export declare function getUser(args?: GetUserArgs, opts?: pulumi.InvokeOptions): Promise<GetUserResult>;
/**
* A collection of arguments for invoking getUser.
*/
export interface GetUserArgs {
/**
* The email address of the IAM user.
*/
email?: string;
/**
* `organizationId`) The ID of the
* organization the user is associated with.
*/
organizationId?: string;
/**
* The tags associated with the user.
*/
tags?: string[];
/**
* The ID of the IAM user.
*
* > **Note** You must specify at least one: `email` and/or `userId`.
*/
userId?: string;
}
/**
* A collection of values returned by getUser.
*/
export interface GetUserResult {
readonly accountRootUserId: string;
readonly createdAt: string;
readonly deletable: boolean;
readonly email?: string;
readonly firstName: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly lastLoginAt: string;
readonly lastName: string;
readonly locale: string;
readonly locked: boolean;
readonly mfa: boolean;
readonly organizationId?: string;
readonly password: string;
readonly passwordWo: string;
readonly passwordWoVersion: number;
readonly phoneNumber: string;
readonly sendPasswordEmail: boolean;
readonly sendWelcomeEmail: boolean;
readonly status: string;
/**
* The tags associated with the user.
*/
readonly tags?: string[];
readonly type: string;
readonly updatedAt: string;
readonly userId?: string;
readonly username: string;
}
/**
* Use this data source to get information on an existing IAM user based on its ID or email address.
* For more information refer to the [IAM API documentation](https://developers.scaleway.com/en/products/iam/api/v1alpha1/#users-06bdcf).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* // Get info by user id
* const findById = scaleway.iam.getUser({
* userId: "11111111-1111-1111-1111-111111111111",
* });
* // Get info by email address
* const findByEmail = scaleway.iam.getUser({
* email: "foo@bar.com",
* });
* ```
*/
export declare function getUserOutput(args?: GetUserOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetUserResult>;
/**
* A collection of arguments for invoking getUser.
*/
export interface GetUserOutputArgs {
/**
* The email address of the IAM user.
*/
email?: pulumi.Input<string | undefined>;
/**
* `organizationId`) The ID of the
* organization the user is associated with.
*/
organizationId?: pulumi.Input<string | undefined>;
/**
* The tags associated with the user.
*/
tags?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* The ID of the IAM user.
*
* > **Note** You must specify at least one: `email` and/or `userId`.
*/
userId?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=getUser.d.ts.map