AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Managed Grafana UpdateWorkspaceAuthentication API operation.

Syntax

Update-MGRFWorkspaceAuthentication
-WorkspaceId <String>
-RoleValues_Admin <String[]>
-SamlConfiguration_AllowedOrganization <String[]>
-AuthenticationProvider <String[]>
-RoleValues_Editor <String[]>
-AssertionAttributes_Email <String>
-AssertionAttributes_Group <String>
-AssertionAttributes_Login <String>
-SamlConfiguration_LoginValidityDuration <Int32>
-AssertionAttributes_Name <String>
-AssertionAttributes_Org <String>
-AssertionAttributes_Role <String>
-IdpMetadata_Url <String>
-IdpMetadata_Xml <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonManagedGrafanaConfig>

Description

Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using SAML. You can also map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the Admin and Editor roles in the workspace. Changes to the authentication method for a workspace may take a few minutes to take effect.

Parameters

-AssertionAttributes_Email <String>
The name of the attribute within the SAML assertion to use as the email names for SAML users.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSamlConfiguration_AssertionAttributes_Email
-AssertionAttributes_Group <String>
The name of the attribute within the SAML assertion to use as the user full "friendly" names for user groups.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSamlConfiguration_AssertionAttributes_Groups
-AssertionAttributes_Login <String>
The name of the attribute within the SAML assertion to use as the login names for SAML users.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSamlConfiguration_AssertionAttributes_Login
-AssertionAttributes_Name <String>
The name of the attribute within the SAML assertion to use as the user full "friendly" names for SAML users.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSamlConfiguration_AssertionAttributes_Name
-AssertionAttributes_Org <String>
The name of the attribute within the SAML assertion to use as the user full "friendly" names for the users' organizations.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSamlConfiguration_AssertionAttributes_Org
-AssertionAttributes_Role <String>
The name of the attribute within the SAML assertion to use as the user roles.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSamlConfiguration_AssertionAttributes_Role
-AuthenticationProvider <String[]>
Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuthenticationProviders
-ClientConfig <AmazonManagedGrafanaConfig>
Amazon.PowerShell.Cmdlets.MGRF.AmazonManagedGrafanaClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IdpMetadata_Url <String>
The URL of the location containing the IdP metadata.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSamlConfiguration_IdpMetadata_Url
-IdpMetadata_Xml <String>
The full IdP metadata, in XML format.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSamlConfiguration_IdpMetadata_Xml
-RoleValues_Admin <String[]>
A list of groups from the SAML assertion attribute to grant the Grafana Admin role to. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSamlConfiguration_RoleValues_Admin
-RoleValues_Editor <String[]>
A list of groups from the SAML assertion attribute to grant the Grafana Editor role to. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSamlConfiguration_RoleValues_Editor
-SamlConfiguration_AllowedOrganization <String[]>
Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace. If this is empty, all organizations in the assertion attribute have access. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSamlConfiguration_AllowedOrganizations
-SamlConfiguration_LoginValidityDuration <Int32>
How long a sign-on session by a SAML user is valid, before the user has to sign on again.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Authentication'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ManagedGrafana.Model.UpdateWorkspaceAuthenticationResponse). Specifying the name of a property of type Amazon.ManagedGrafana.Model.UpdateWorkspaceAuthenticationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WorkspaceId <String>
The ID of the workspace to update the authentication for.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.ManagedGrafana.Model.AuthenticationDescription or Amazon.ManagedGrafana.Model.UpdateWorkspaceAuthenticationResponse
This cmdlet returns an Amazon.ManagedGrafana.Model.AuthenticationDescription object. The service call response (type Amazon.ManagedGrafana.Model.UpdateWorkspaceAuthenticationResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z