Guide

API credential

Disable-IAMAPICredential

Suggest Edits

Synopsis

Deactivate credentials.

Syntax

Disable-IAMAPICredential [[-ClientID] <String>] [[-CredentialID] <String>] [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Deactivates all credentials for a given client ID or deactivates an individual credential by its credential ID.

Note: If you don't specify a value for the -ClientID parameter, it takes the value self and operates on the API client you're using to perform this operation.

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

Your API client's ID. To get this value, run Get-IAMAPIClient.
‑CredentialID
String Pipeline input: False

Your credentials' ID. To get this value for your credentials, run Get-IAMAPICredential.
‑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.

Related Links

Updated 6 days ago