Guide

Role

Get-IAMRole

Suggest Edits

Synopsis

Get a role.

Syntax

Get-IAMRole [-RoleID <String>] [-Actions] [-GroupID <Int32>] [-Users] [-IgnoreContext] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Get-IAMRole [-RoleID <String>] [-Actions] [-GrantedRoles] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Gets IAM roles or returns a specific role by its ID. You can filter the results depending on whether you are listing all or retrieving an individual record by adding additional switch parameters, such as -Actions (global), -GrantedRoles (individual), -GroupID, -Users, or -IgnoreContext (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.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑GrantedRoles
Switch Parameter sets: single Pipeline input: False

Lists granted roles assigned for a role.
‑GroupID
Int Parameter sets: all Pipeline input: False

Your group's ID.
‑IgnoreContext
Switch Parameter sets: all Pipeline input: False

Returns all the roles for the current account, ignoring the contract type of your API client.
‑RoleID
String Pipeline input: False

The role's ID.
‑Section
String Pipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.
‑Users
Switch Parameter sets: all Pipeline input: False

A list of users assigned to the roles.

Related Links

Updated 8 days ago