Guide

Keys from collection

Remove-APIKeyFromCollection

Suggest Edits

Synopsis

Unassign keys.

Syntax

Remove-APIKeyFromCollection -CollectionIDs <Object> -KeyIDs <Object> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Remove-APIKeyFromCollection -Body <Object> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Unassigns keys from collections.

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
Conditionally required
Object Parameter sets: body Pipeline input: ByValue

A request body, either as a PSCustomObject or a string. This parameter supports pipelining.
‑CollectionIDs
Conditionally required
Object Parameter sets: attributes Pipeline input: False

A comma-separated string containing key collection IDs. You can retrieve these with Get-APIKeyCollection.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑KeyIDs
Conditionally required
Object Parameter sets: attributes Pipeline input: False

A comma-separated string containing key IDs. You can retrieve these with Get-APIKey.
‑Section
String Pipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.

Related Links

Updated 3 days ago