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
Lists only the APIs the user can access.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-AccountSwitchKey
Account switch key, for use when you have access to multiple accounts and need to specify which one to use. Account Switch Keys can be found using Get-AccountSwitchKey
.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Actions
Includes actions you can perform on the object.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-ClientID
Unique identifier for each API client.
To get this value, run Get-IAMAPIClient.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Credentials
Includes API user's credentials.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-EdgeRCFile
EdgeRC file to authenticate your command. Defaults to ~/.edgerc
.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-GroupAccess
Includes the API client's group access.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-IPACL
Includes the API client's IP list restriction.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Section
EdgeRC section to retrieve authentication credentials from. Defaults to default
.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common Parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
None
Outputs
System.Object