AmazonCognitoIdentityProviderClient.GetClientToken Method (GetClientTokenRequest)

Issues an access token for machine-to-machine (M2M) authorization. Your app client provides its client ID and secret, and receives an access token that authorizes requests to your resource servers. GetClientToken provides the same functionality as the OAuth2 client-credentials grant; both authorize an application rather than a user.

To use this operation, you must configure the app client with a client secret and enable the ALLOW_CLIENT_TOKEN_AUTH authentication flow. The ALLOW_CLIENT_TOKEN_AUTH flow is mutually exclusive with user authentication flows. It must be the only authentication flow that you configure for the app client. For more information, see Scopes, M2M, and resource servers.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to GetClientTokenAsync.

Namespace: Amazon.CognitoIdentityProvider
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z

Syntax

public virtual GetClientTokenResponse GetClientToken(
         GetClientTokenRequest request
)

Parameters

request: Type: Amazon.CognitoIdentityProvider.Model.GetClientTokenRequest

Container for the necessary parameters to execute the GetClientToken service method.

Return Value

Type: GetClientTokenResponse

The response from the GetClientToken service method, as returned by CognitoIdentityProvider.

Exceptions

Exception	Condition
ForbiddenException	This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.
InternalErrorException	This exception is thrown when Amazon Cognito encounters an internal error.
InvalidParameterException	This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
NotAuthorizedException	This exception is thrown when a user isn't authorized.
OperationNotEnabledException	This exception is thrown when an operation is not available in the current region or for the current user pool configuration. This can occur when attempting to perform operations that are not supported in secondary replica regions.
ResourceNotFoundException	This exception is thrown when the Amazon Cognito service can't find the requested resource.
TooManyRequestsException	This exception is thrown when the user has made too many requests for a given operation.

Examples

The following example gets an access token for the app client 1example23456789 with the custom scope solar-system-data/asteroids.add.

Example – Get an access token for machine-to-machine authorization


var client = new AmazonCognitoIdentityProviderClient();
var response = client.GetClientToken(new GetClientTokenRequest 
{
    ClientId = "1example23456789",
    Scopes = new List<string> {
        "solar-system-data/asteroids.add"
    },
    Secret = "exampleClientSecret123EXAMPLE"
});

ClientAuthenticationResultType clientAuthenticationResult = response.ClientAuthenticationResult;

Version Information

.NET Framework:
Supported in: 4.7.2 and newer

AmazonCognitoIdentityProviderClient.GetClientToken (GetClientTokenRequest)

Method