Guide

User password

Reset-IAMUserPassword

Suggest Edits

Synopsis

Reset a user's password.

Syntax

Reset-IAMUserPassword [-UIIdentityID] <String> [-SendEmail] [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Resets the password for a user specified by their UIIdentityID. Optionally, you can send a randomly generated one-time use password to the user by adding the -SendEmail switch parameter.

If you send an email with the password directly to the user, the response for this operation doesn't include that password. If you don't send it, the password is included in the response.

Parameters

‑AccountSwitchKey
String Pipeline input: False

An account credential key that lets you move between accounts when using an API client enabled for multiple accounts. To find account switch keys, use Get-AccountSwitchKey.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑Section
String Pipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.
‑SendEmail
Switch Pipeline input: False

Sends a one-time password to the new user.
‑UIIdentityID
Required
String Pipeline input: False

A given user's ID. To get this value, run Get-IAMUser.

Related Links

Updated 10 days ago