Guide

User

Set-IAMUser

Suggest Edits

Synopsis

Update a user.

Syntax

Set-IAMUser [-UIIdentityID] <String> [-Body] <Object> [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Modifies a specified user's information. It's recommended that you retrieve the user's information via the Get-IAMUser operation, edit it locally, and then pipe the result to this function.

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.
‑Body
Required
Object Pipeline input: ByValue

A request body, either as a PSCustomObject or a string. This parameter supports pipelining.
‑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.
‑UIIdentityID
Required
String Pipeline input: False

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

Related Links

Updated 17 days ago