API credential

New-IAMAPICredential

Synopsis

Create a credential.

Syntax

New-IAMAPICredential [[-ClientID] <String>] [-APIResponseOnly] [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Creates a new credential for your API client or for another API client by specifying their client ID. If you want to create a credential for your API client, specify a value of self in the -ClientID parameter.

Note: This is the only time you'll see the client secret. Save the credential to avoid the need to create a new one.

Parameters

‑APIResponseOnly

By default, the function will include the AccessToken and Host elements in the response object so you can pipe this into Export-EdgeGridCredentials. Set this option if you would rather only the elements present in the API response are returned.

‑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.

‑ClientID

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

‑EdgeRCFile

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

‑Section

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

Related Links


Did this page help you?