Guide

User

Lock-IAMUser

Suggest Edits

Synopsis

Lock a user's account.

Syntax

Lock-IAMUser [-UIIdentityID] <String> [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Locks a specified user's account, preventing them from accessing Control Center. The result shows as a read-only isLocked: true attribute in the user data.

To allow the user to access Control Center, run the Unlock-IAMUser operation. This sets the isLocked attribute to false.

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.
‑UIIdentityID
Required
String Pipeline input: False

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

Related Links

Updated 8 days ago