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 Verified Permissions UpdateIdentitySource API operation.

Syntax

Update-AVPIdentitySource
-AccessTokenOnly_Audience <String[]>
-CognitoUserPoolConfiguration_ClientId <String[]>
-IdentityTokenOnly_ClientId <String[]>
-OpenIdConnectConfiguration_EntityIdPrefix <String>
-OpenIdConnectConfiguration_GroupClaim <String>
-GroupConfiguration_GroupEntityType <String>
-OpenIdConnectConfiguration_GroupEntityType <String>
-IdentitySourceId <String>
-OpenIdConnectConfiguration_Issuer <String>
-PolicyStoreId <String>
-PrincipalEntityType <String>
-AccessTokenOnly_PrincipalIdClaim <String>
-IdentityTokenOnly_PrincipalIdClaim <String>
-CognitoUserPoolConfiguration_UserPoolArn <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonVerifiedPermissionsConfig>

Description

Updates the specified identity source to use a new identity provider (IdP), or to change the mapping of identities from the IdP to a different principal entity type. Verified Permissions is eventually consistent. It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.

Parameters

-AccessTokenOnly_Audience <String[]>
The access token aud claim values that you want to accept in your policy store. For example, https://myapp.example.com, https://myapp2.example.com. 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)
AliasesUpdateConfiguration_OpenIdConnectConfiguration_TokenSelection_AccessTokenOnly_Audiences
-AccessTokenOnly_PrincipalIdClaim <String>
The claim that determines the principal in OIDC access tokens. For example, sub.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesUpdateConfiguration_OpenIdConnectConfiguration_TokenSelection_AccessTokenOnly_PrincipalIdClaim
-ClientConfig <AmazonVerifiedPermissionsConfig>
Amazon.PowerShell.Cmdlets.AVP.AmazonVerifiedPermissionsClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CognitoUserPoolConfiguration_ClientId <String[]>
The client ID of an app client that is configured for the specified Amazon Cognito user pool. 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)
AliasesUpdateConfiguration_CognitoUserPoolConfiguration_ClientIds
-CognitoUserPoolConfiguration_UserPoolArn <String>
The Amazon Resource Name (ARN) of the Amazon Cognito user pool associated with this identity source.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesUpdateConfiguration_CognitoUserPoolConfiguration_UserPoolArn
-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)
-GroupConfiguration_GroupEntityType <String>
The name of the schema entity type that's mapped to the user pool group. Defaults to AWS::CognitoGroup.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesUpdateConfiguration_CognitoUserPoolConfiguration_GroupConfiguration_GroupEntityType
-IdentitySourceId <String>
Specifies the ID of the identity source that you want to update.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-IdentityTokenOnly_ClientId <String[]>
The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider. For example, 1example23456789, 2example10111213. 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)
AliasesUpdateConfiguration_OpenIdConnectConfiguration_TokenSelection_IdentityTokenOnly_ClientIds
-IdentityTokenOnly_PrincipalIdClaim <String>
The claim that determines the principal in OIDC access tokens. For example, sub.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesUpdateConfiguration_OpenIdConnectConfiguration_TokenSelection_IdentityTokenOnly_PrincipalIdClaim
-OpenIdConnectConfiguration_EntityIdPrefix <String>
A descriptive string that you want to prefix to user entities from your OIDC identity provider. For example, if you set an entityIdPrefix of MyOIDCProvider, you can reference principals in your policies in the format MyCorp::User::MyOIDCProvider|Carlos.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesUpdateConfiguration_OpenIdConnectConfiguration_EntityIdPrefix
-OpenIdConnectConfiguration_GroupClaim <String>
The token claim that you want Verified Permissions to interpret as group membership. For example, groups.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesUpdateConfiguration_OpenIdConnectConfiguration_GroupConfiguration_GroupClaim
-OpenIdConnectConfiguration_GroupEntityType <String>
The policy store entity type that you want to map your users' group claim to. For example, MyCorp::UserGroup. A group entity type is an entity that can have a user entity type as a member.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesUpdateConfiguration_OpenIdConnectConfiguration_GroupConfiguration_GroupEntityType
-OpenIdConnectConfiguration_Issuer <String>
The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path .well-known/openid-configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesUpdateConfiguration_OpenIdConnectConfiguration_Issuer
-PolicyStoreId <String>
Specifies the ID of the policy store that contains the identity source that you want to update.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-PrincipalEntityType <String>
Specifies the data type of principals generated for identities authenticated by the identity source.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VerifiedPermissions.Model.UpdateIdentitySourceResponse). Specifying the name of a property of type Amazon.VerifiedPermissions.Model.UpdateIdentitySourceResponse 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)

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.VerifiedPermissions.Model.UpdateIdentitySourceResponse
This cmdlet returns an Amazon.VerifiedPermissions.Model.UpdateIdentitySourceResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

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