Guide

API credential

Get-IAMAPICredential

Suggest Edits

Synopsis

Get a credential.

Syntax

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

Description

Gets all API credentials or returns a specific API credential by its ID.

Note: If you don't specify a value for the -ClientID parameter, it takes the value of 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.
‑Actions
Switch Pipeline input: False

When enabled, includes actions you can perform on the object.
‑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 10 days ago