API client

Synopsis

Get an API client.

Syntax

Get-IAMAPIClient [-ClientID <String>] [-Actions] [-GroupAccess] [-APIAccess] [-Credentials] [-IPACL] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Gets API clients or returns a specific API client by its ID. If you want to retrieve your own API client, specify a value of self in the -ClientID parameter. You can optionally filter the results by adding additional switch parameters, such as -Actions, -GroupAccess, -APIAccess, -Credentials, or -IPACL.

Parameters

‑APIAccess	SwitchParameter sets: `single`Pipeline input: False Lists only the APIs the user can access.
‑AccountSwitchKey	StringPipeline 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	SwitchPipeline input: False When enabled, includes actions you can perform on the object.
‑ClientID	StringParameter sets: `single`Pipeline input: False Your API client's ID. To get this value, run `Get-IAMAPIClient`.
‑Credentials	SwitchParameter sets: `single`Pipeline input: False When enabled, includes the API user's credentials.
‑EdgeRCFile	StringPipeline input: False Your EdgeGrid resource file to authenticate your command. Defaults to `~/.edgerc`.
‑GroupAccess	SwitchParameter sets: `single`Pipeline input: False When enabled, includes the API client's group access.
‑IPACL	SwitchParameter sets: `single`Pipeline input: False When enabled, includes the API client's IP list restriction.
‑Section	StringPipeline input: False The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to `default`.

Related Links

Updated 2 months ago