Package software.amazon.awssdk.services.cognitoidentityprovider.model

Interface GetTokensFromRefreshTokenRequest.Builder

    • Method Detail

      • refreshToken

        GetTokensFromRefreshTokenRequest.Builder refreshToken​(String refreshToken)

        A valid refresh token that can authorize the request for new tokens. When refresh token rotation is active in the requested app client, this token is invalidated after the request is complete.

        Parameters:
        refreshToken - A valid refresh token that can authorize the request for new tokens. When refresh token rotation is active in the requested app client, this token is invalidated after the request is complete.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clientId

        GetTokensFromRefreshTokenRequest.Builder clientId​(String clientId)

        The app client that issued the refresh token to the user who wants to request new tokens.

        Parameters:
        clientId - The app client that issued the refresh token to the user who wants to request new tokens.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clientSecret

        GetTokensFromRefreshTokenRequest.Builder clientSecret​(String clientSecret)

        The client secret of the requested app client, if the client has a secret.

        Parameters:
        clientSecret - The client secret of the requested app client, if the client has a secret.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • deviceKey

        GetTokensFromRefreshTokenRequest.Builder deviceKey​(String deviceKey)

        When you enable device remembering, Amazon Cognito issues a device key that you can use for device authentication that bypasses multi-factor authentication (MFA). To implement GetTokensFromRefreshToken in a user pool with device remembering, you must capture the device key from the initial authentication request. If your application doesn't provide the key of a registered device, Amazon Cognito issues a new one. You must provide the confirmed device key in this request if device remembering is enabled in your user pool.

        For more information about device remembering, see Working with devices.

        Parameters:
        deviceKey - When you enable device remembering, Amazon Cognito issues a device key that you can use for device authentication that bypasses multi-factor authentication (MFA). To implement GetTokensFromRefreshToken in a user pool with device remembering, you must capture the device key from the initial authentication request. If your application doesn't provide the key of a registered device, Amazon Cognito issues a new one. You must provide the confirmed device key in this request if device remembering is enabled in your user pool.

        For more information about device remembering, see Working with devices.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clientMetadata

        GetTokensFromRefreshTokenRequest.Builder clientMetadata​(Map<String,​String> clientMetadata)

        A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.

        You create custom workflows by assigning Lambda functions to user pool triggers. When you use the GetTokensFromRefreshToken API action, Amazon Cognito invokes the Lambda function the pre token generation trigger.

        For more information, see Using 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.

        Parameters:
        clientMetadata - A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.

        You create custom workflows by assigning Lambda functions to user pool triggers. When you use the GetTokensFromRefreshToken API action, Amazon Cognito invokes the Lambda function the pre token generation trigger.

        For more information, see Using 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.