Guide

API client

New-IAMAPIClient

Suggest Edits

Synopsis

Create an API client.

Syntax

New-IAMAPIClient [-Body] <Object> [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Creates a new API client. Optionally, you can automatically assign a credential for the client when you create it. If you choose not to assign the credential automatically, see the Create authentication credentials guide for details.

Note: As the format of the request body is complex, if you have an existing user, it's recommended that you retrieve it with the Get-IAMAPIClient operation, edit it locally, and pipe the edited object to this function.

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.
‑Body
Required
Object Pipeline input: ByValue

A request body, either as a PSCustomObject or a string. This parameter supports pipelining.
‑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 about 1 month ago