AWS SDK for .NET Documentation
GetFederationTokenRequest Class
AmazonAmazon.SecurityToken.ModelGetFederationTokenRequest Did this page help you?   Yes   No    Tell us about it...
Container for the parameters to the GetFederationToken operation. 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 gets temporary security credentials on behalf of distributed applications inside a corporate network. Because you must call the
CopyC#
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

CopyC#
AssumeRoleWithWebIdentity
.

The

CopyC#
GetFederationToken
action must be called by using the long-term AWS security credentials of an IAM user. You can also call
CopyC#
GetFederationToken
using the security credentials of an AWS account (root), but this is not recommended. Instead, we recommend that you create an IAM user for the purpose of the proxy application and then attach a policy to the IAM user that limits federated users to only the actions and resources they need access to. For more information, see IAM Best Practices in Using IAM.

The temporary security credentials that are obtained by using the long-term credentials of an IAM user are valid for the specified duration, between 900 seconds (15 minutes) and 129600 seconds (36 hours). Temporary credentials that are obtained by using AWS account (root) credentials have a maximum duration of 3600 seconds (1 hour)

Permissions

The permissions for the temporary security credentials returned by

CopyC#
GetFederationToken
are determined by a combination of the following:

The passed policy is attached to the temporary security credentials that result from the

CopyC#
GetFederationToken
API call--that is, to the federated user. When the federated user makes an AWS request, AWS evaluates the policy attached to the federated user in combination with the policy or policies attached to the IAM user whose credentials were used to call
CopyC#
GetFederationToken
. AWS allows the federated user's request only when both the federated user and the IAM user are explicitly allowed to perform the requested action. The passed policy cannot grant more permissions than those that are defined in the IAM user policy.

A typical use case is that the permissions of the IAM user whose credentials are used to call

CopyC#
GetFederationToken
are designed to allow access to all the actions and resources that any federated user will need. Then, for individual users, you pass a policy to the operation that scopes down the permissions to a level that's appropriate to that individual user, using a policy that allows only a subset of permissions that are granted to the IAM user.

If you do not pass a policy, the resulting temporary security credentials have no effective permissions. The only exception is when the temporary security credentials are used to access a resource that has a resource-based policy that specifically allows the federated user to access the resource.

For more information about how permissions work, see Permissions for GetFederationToken in Using Temporary Security Credentials. For information about using

CopyC#
GetFederationToken
to create temporary security credentials, see Creating Temporary Credentials to Enable Access for Federated Users in Using Temporary Security Credentials.

Declaration Syntax
C#
public class GetFederationTokenRequest : AmazonWebServiceRequest
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
GetFederationTokenRequest()()()()
Initializes a new instance of the GetFederationTokenRequest class

DurationSeconds
Gets and sets the property DurationSeconds.

The duration, in seconds, that the session should last. Acceptable durations for federation sessions range from 900 seconds (15 minutes) to 129600 seconds (36 hours), with 43200 seconds (12 hours) as the default. Sessions obtained using AWS account (root) credentials are restricted to a maximum of 3600 seconds (one hour). If the specified duration is longer than one hour, the session obtained by using AWS account (root) credentials defaults to one hour.


Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
Name
Gets and sets the property Name.

The name of the federated user. The name is used as an identifier for the temporary security credentials (such as

CopyC#
Bob
). For example, you can reference the federated user name in a resource-based policy, such as in an Amazon S3 bucket policy.


Policy
Gets and sets the property Policy.

An IAM policy in JSON format that is passed with the

CopyC#
GetFederationToken
call and evaluated along with the policy or policies that are attached to the IAM user whose credentials are used to call
CopyC#
GetFederationToken
. The passed policy is used to scope down the permissions that are available to the IAM user, by allowing only a subset of the permissions that are granted to the IAM user. The passed policy cannot grant more permissions than those granted to the IAM user. The final permissions for the federated user are the most restrictive set based on the intersection of the passed policy and the IAM user policy.

If you do not pass a policy, the resulting temporary security credentials have no effective permissions. The only exception is when the temporary security credentials are used to access a resource that has a resource-based policy that specifically allows the federated user to access the resource.

For more information about how permissions work, see Permissions for GetFederationToken in Using Temporary Security Credentials.


ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
WithDurationSeconds(Int32) Obsolete.
Sets the DurationSeconds property

WithName(String) Obsolete.
Sets the Name property

WithPolicy(String) Obsolete.
Sets the Policy property

Inheritance Hierarchy
Object
AmazonWebServiceRequest
 GetFederationTokenRequest

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)