AmazonSecurityTokenServiceClient.GetFederationToken Method (GetFederationTokenRequest)

.NET Framework 3.5
 
 
 
Did this page help you?  Yes  No   Tell us about it...

Returns a set of temporary security credentials (consisting of an access key ID, a secret access key, and a security token) for a federated user. A typical use is in a proxy application that is getting temporary security credentials on behalf of distributed applications inside a corporate network. Because you must call the GetFederationToken action using the long-term security credentials of an IAM user, this call is appropriate in contexts where those credentials can be safely stored, usually in a server-based application.

Note: Do not use this call in mobile applications or client-based web applications that directly get temporary security credentials. For those types of applications, use AssumeRoleWithWebIdentity .

The GetFederationToken action must be called by using the long-term AWS security credentials of the AWS account or an IAM user. Credentials that are created by IAM users are valid for the specified duration, between 900 seconds (15 minutes) and 129600 seconds (36 hours); credentials that are created by using account credentials have a maximum duration of 3600 seconds (1 hour).

The permissions that are granted to the federated user are the intersection of the policy that is passed with the GetFederationToken request and policies that are associated with of the entity making the GetFederationToken call.

For more information about how permissions work, see Controlling Permissions in Temporary Credentials in Using Temporary Security Credentials . For information about using GetFederationToken to create temporary security credentials, see Creating Temporary Credentials to Enable Access for Federated Users in Using Temporary Security Credentials .

Namespace: Amazon.SecurityToken
Assembly: AWSSDK.dll
Version: 2.0.0.3

Syntax

C#
public virtual GetFederationTokenResponse GetFederationToken(
         GetFederationTokenRequest getFederationTokenRequest
)

Parameters

getFederationTokenRequest
Type: Amazon.SecurityToken.Model.GetFederationTokenRequest

Container for the necessary parameters to execute the GetFederationToken service method on AmazonSecurityTokenService.

Return Value
Type: Amazon.SecurityToken.Model.GetFederationTokenResponse
The response from the GetFederationToken service method, as returned by AmazonSecurityTokenService.

Exceptions

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5