Guide

Property users

Block-IAMPropertyUsers

Suggest Edits

Synopsis

Block users from a property.

Syntax

Block-IAMPropertyUsers [-AssetID] <Int32> [-UIIdentityID] <String> [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Blocks a user from accessing one or more properties by specifying their IDs.

Note: You can retrieve the property IDs in the IAM API by running the Get-IAMProperty operation. The property IDs are equivalent to the asset IDs from the Property API.

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.
‑AssetID
Required
Int Pipeline input: False

Unique identifier for each asset, either a property or an include. To get this value, run Get-IAMProperty.
‑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: ByValue

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

Related Links

Updated 20 days ago