API credential

Set-IAMAPICredential

Synopsis

Update a credential.

Syntax

Set-IAMAPICredential [-ClientID <String>] -CredentialID <String> -ExpiresOn <String> -Status <String> [-Description <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Set-IAMAPICredential [-ClientID <String>] -CredentialID <String> -Body <Object> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Updates a specific credential for an API client. You can change the expiration date and description, or toggle the activation status.

Parameters

‑AccountSwitchKey

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

A request body, either as a PSCustomObject or a string. This parameter supports pipelining.

‑ClientID

Your API client's ID. To get this value, run Get-IAMAPIClient.

‑CredentialID
Required

Your credentials' ID. To get this value for your credentials, run Get-IAMAPICredential.

‑Description

A human-readable description for the credential.

‑EdgeRCFile

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.

‑ExpiresOn
Conditionally required

An ISO 8601 timestamp for when the credential no longer provides access. The default expiration date is two years from the creation date.

‑Section

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

‑Status
Conditionally required

Indicates whether a credential is ACTIVE, INACTIVE, or DELETED. You can switch a credential's status between ACTIVE and INACTIVE. Note that once you change the status to DELETED, you've actually deleted it and it can't be reactivated.

Related Links