Guide

Group

Get-IAMGroup

Suggest Edits

Synopsis

Get a group.

Syntax

Get-IAMGroup [[-GroupID] <Int32>] [-Actions] [-Flatten] [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Gets all groups or returns a specific group by its ID that you, as an admin, can manage for the current account and contract type or other managed accounts.

Note: It's different to how other APIs return the group data, that is, the IAM API nests groups inside their parents. If you want a flattened list of groups without nesting, use the -Flatten parameter.

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.
‑Actions
Switch Pipeline input: False

When enabled, includes actions you can perform on the object.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑Flatten
Switch Pipeline input: False

Collapses the response so that child groups are not nested within parents and the response is a single-level array.
‑GroupID
Int Pipeline input: False

Your group's ID.
‑Section
String Pipeline input: False

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

Related Links

Updated 8 days ago