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 Sign-In Data Plane CreateOAuth2Token API operation.

Syntax

New-AMSPOAuth2Token
-TokenInput_ClientId <String>
-TokenInput_Code <String>
-TokenInput_CodeVerifier <String>
-TokenInput_GrantType <String>
-TokenInput_RedirectUri <String>
-TokenInput_RefreshToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonSigninConfig>

Description

CreateOAuth2Token API Path: /v1/token Request Method: POST Content-Type: application/json or application/x-www-form-urlencoded This API implements OAuth 2.0 flows for AWS Sign-In CLI clients, supporting both:
  1. Authorization code redemption (grant_type=authorization_code) - NOT idempotent
  2. Token refresh (grant_type=refresh_token) - Idempotent within token validity window
The operation behavior is determined by the grant_type parameter in the request body: Authorization Code Flow (NOT Idempotent):
  • JSON or form-encoded body with client_id, grant_type=authorization_code, code, redirect_uri, code_verifier
  • Returns access_token, token_type, expires_in, refresh_token, and id_token
  • Each authorization code can only be used ONCE for security (prevents replay attacks)
Token Refresh Flow (Idempotent):
  • JSON or form-encoded body with client_id, grant_type=refresh_token, refresh_token
  • Returns access_token, token_type, expires_in, and refresh_token (no id_token)
  • Multiple calls with same refresh_token return consistent results within validity window
Authentication and authorization:
  • Confidential clients: sigv4 signing required with signin:ExchangeToken permissions
  • CLI clients (public): authn/authz skipped based on client_id & grant_type
Note: This operation cannot be marked as @idempotent because it handles both idempotent (token refresh) and non-idempotent (auth code redemption) flows in a single endpoint.

Parameters

-ClientConfig <AmazonSigninConfig>
Amazon.PowerShell.Cmdlets.AMSP.AmazonSigninClientCmdlet.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)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'TokenOutput'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Signin.Model.CreateOAuth2TokenResponse). Specifying the name of a property of type Amazon.Signin.Model.CreateOAuth2TokenResponse 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)
-TokenInput_ClientId <String>
The client identifier (ARN) used during Sign-In onboarding Required for both authorization code and refresh token flows
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-TokenInput_Code <String>
The authorization code received from /v1/authorize Required only when grant_type=authorization_code
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TokenInput_CodeVerifier <String>
PKCE code verifier to prove possession of the original code challenge Required only when grant_type=authorization_code
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TokenInput_GrantType <String>
OAuth 2.0 grant type - determines which flow is used Must be "authorization_code" or "refresh_token"
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-TokenInput_RedirectUri <String>
The redirect URI that must match the original authorization request Required only when grant_type=authorization_code
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TokenInput_RefreshToken <String>
The refresh token returned from auth_code redemption Required only when grant_type=refresh_token
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.Signin.Model.CreateOAuth2TokenResponseBody or Amazon.Signin.Model.CreateOAuth2TokenResponse
This cmdlet returns an Amazon.Signin.Model.CreateOAuth2TokenResponseBody object. The service call response (type Amazon.Signin.Model.CreateOAuth2TokenResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

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