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 AWS Single Sign-On Admin PutApplicationGrant API operation.

Syntax

Write-SSOADMNApplicationGrant
-ApplicationArn <String>
-JwtBearer_AuthorizedTokenIssuer <AuthorizedTokenIssuer[]>
-GrantType <GrantType>
-AuthorizationCode_RedirectUris <String[]>
-Grant_RefreshToken <RefreshTokenGrant>
-Grant_TokenExchange <TokenExchangeGrant>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonSSOAdminConfig>

Description

Creates a configuration for an application to use grants. Conceptually grants are authorization to request actions related to tokens. This configuration will be used when parties are requesting and receiving tokens during the trusted identity propagation process. For more information on the IAM Identity Center supported grant workflows, see SAML 2.0 and OAuth 2.0. A grant is created between your applications and Identity Center instance which enables an application to use specified mechanisms to obtain tokens. These tokens are used by your applications to gain access to Amazon Web Services resources on behalf of users. The following elements are within these exchanges:
  • Requester - The application requesting access to Amazon Web Services resources.
  • Subject - Typically the user that is requesting access to Amazon Web Services resources.
  • Grant - Conceptually, a grant is authorization to access Amazon Web Services resources. These grants authorize token generation for authenticating access to the requester and for the request to make requests on behalf of the subjects. There are four types of grants:
    • AuthorizationCode - Allows an application to request authorization through a series of user-agent redirects.
    • JWT bearer - Authorizes an application to exchange a JSON Web Token that came from an external identity provider. To learn more, see RFC 6479.
    • Refresh token - Enables application to request new access tokens to replace expiring or expired access tokens.
    • Exchange token - A grant that requests tokens from the authorization server by providing a ‘subject’ token with access scope authorizing trusted identity propagation to this application. To learn more, see RFC 8693.
  • Authorization server - IAM Identity Center requests tokens.
User credentials are never shared directly within these exchanges. Instead, applications use grants to request access tokens from IAM Identity Center. For more information, see RFC 6479. Use cases
  • Connecting to custom applications.
  • Configuring an Amazon Web Services service to make calls to another Amazon Web Services services using JWT tokens.

Parameters

-ApplicationArn <String>
Specifies the ARN of the application to update.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-AuthorizationCode_RedirectUris <String[]>
A list of URIs that are valid locations to redirect a user's browser after the user is authorized.RedirectUris is required when the grant type is authorization_code. 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)
AliasesGrant_AuthorizationCode_RedirectUris
-ClientConfig <AmazonSSOAdminConfig>
Amazon.PowerShell.Cmdlets.SSOADMN.AmazonSSOAdminClientCmdlet.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)
-Grant_RefreshToken <RefreshTokenGrant>
Configuration options for the refresh_token grant type.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Grant_TokenExchange <TokenExchangeGrant>
Configuration options for the urn:ietf:params:oauth:grant-type:token-exchange grant type.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-GrantType <GrantType>
Specifies the type of grant to update.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-JwtBearer_AuthorizedTokenIssuer <AuthorizedTokenIssuer[]>
A list of allowed token issuers trusted by the Identity Center instances for this application.AuthorizedTokenIssuers is required when the grant type is JwtBearerGrant. 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)
AliasesGrant_JwtBearer_AuthorizedTokenIssuers
-Select <String>
Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SSOAdmin.Model.PutApplicationGrantResponse). 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

None or Amazon.SSOAdmin.Model.PutApplicationGrantResponse
This cmdlet does not generate any output.The service response (type Amazon.SSOAdmin.Model.PutApplicationGrantResponse) be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

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