EdgeGrid credentials

Synopsis

Export EdgeGrid credentials to a file.

Syntax

Export-EdgegridCredentials [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>] [-HostName] <String> [-ClientToken] <String> [-AccessToken] <String> [-ClientSecret] <String> [-Force] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

This function will take a given set of EdgeGrid credentials and write them to a .edgerc file, either in the [default] section or a custom section if provided.

Parameters

‑AccessToken
Alias: ‑access_token
Required

Access token.

‑AccountSwitchKey
Alias: ‑AccountKey, account_key

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.

‑ClientSecret
Alias: ‑client_secret
Required

The API credential's client secret.

‑ClientToken
Alias: ‑client_token
Required

The API credential's client token.

‑EdgeRCFile

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

‑Force

Overwrite an existing section in your EdgeRCFile, if it exists.

‑HostName
Alias: ‑host
Required

The API credential's hostname.

‑Section

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

Related Links

User Guide: Overview