GetClientTokenRequest Class | AWS SDK for .NET Version 4

Container for the parameters to the GetClientToken operation. 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.

In this article ▶

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CognitoIdentityProvider.AmazonCognitoIdentityProviderRequest
      Amazon.CognitoIdentityProvider.Model.GetClientTokenRequest

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

Syntax

public class GetClientTokenRequest : AmazonCognitoIdentityProviderRequest
         IAmazonWebServiceRequest

The GetClientTokenRequest type exposes the following members

Constructors

	Name	Description
	GetClientTokenRequest()

Properties

Name	Type	Description
ClientId	System.String	Gets and sets the property ClientId. The ID of the app client that requests the access token. The app client must have a client secret and the `ALLOW_CLIENT_TOKEN_AUTH` authentication flow.
ClientMetadata	System.Collections.Generic.Dictionary<System.String, System.String>	Gets and sets the property ClientMetadata. A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. You create custom workflows by assigning Lambda functions to user pool triggers. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a `clientMetadata` attribute that provides the data that you assigned to the ClientMetadata parameter in your request. In your function code, you can process the `clientMetadata` value to enhance your workflow for your specific needs. To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see Connecting API actions to Lambda triggers in the Amazon Cognito Developer Guide. When you use the `ClientMetadata` parameter, note that Amazon Cognito won't do the following: Store the `ClientMetadata` value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the `ClientMetadata` parameter serves no purpose. Validate the `ClientMetadata` value. Encrypt the `ClientMetadata` value. Don't send sensitive information in this parameter. 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.
Scopes	System.Collections.Generic.List<System.String>	Gets and sets the property Scopes. The custom scopes to authorize in the access token, in the format `resource-server-identifier/scope-name`. Each scope must belong to a resource server in your user pool. If you don't specify any scopes, Amazon Cognito authorizes the scopes that are configured for the app client. 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.
Secret	System.String	Gets and sets the property Secret. An active secret for the app client.

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:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer