API credential

Set-IAMAPICredential

Synopsis

Update a credential.

Syntax

Parameters (Default)

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

body

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, description, or toggle the activation status.

Parameters

-AccountSwitchKey

Account switch key, for use when you have access to multiple accounts and need to specify which one to use. Run Get-AccountSwitchKey to list the account switch keys available to you.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Body

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

Type: Object
Parameter Sets: body
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ClientID

Unique identifier for each API client. To get this value, run Get-IAMAPIClient.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CredentialID

Unique identifier for each credential. To get this value for your credentials, run Get-IAMAPICredential.

Type: String
Parameter Sets: (All)
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Description

Your own notes or Description for the credential.

Type: String
Parameter Sets: Parameters
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EdgeRCFile

EdgeRC file to authenticate your command. Defaults to ~/.edgerc.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ExpiresOn

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

Type: String
Parameter Sets: Parameters
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Section

EdgeRC section to retrieve authentication credentials from. Defaults to default.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Status

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.

Type: String
Parameter Sets: Parameters
Aliases:
Accepted values: ACTIVE, INACTIVE, DELETED

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

System.Object

Outputs