Guide

User

Get-IAMUser

Suggest Edits

Synopsis

Get a user.

Syntax

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

Get-IAMUser [-UIIdentityID <String>] [-Actions] [-AuthGrants] [-Notifications] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Gets all IAM users or returns a specific user by their -UIIdentityID. You can filter the results depending on whether you are listing all or retrieving a specific record by adding additional switch parameters, such as -Actions or -AuthGrants (global), -Notifications (individual), or -GroupID (all).

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

A list of your group and role assignments.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑GroupID
Int Parameter sets: all Pipeline input: False

Your group's ID.
‑Notifications
Switch Parameter sets: single Pipeline input: False

Product notifications you subscribe to.
‑Section
String Pipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.
‑UIIdentityID
String Parameter sets: single Pipeline input: False

A given user's ID. To get this value, run Get-IAMUser.

Related Links

Updated about 1 month ago