AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
GetFederationTokenaction 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.
If you are creating a mobile-based or browser-based app that can authenticate users
using a web identity provider like Login with Amazon, Facebook, Google, or an OpenID
Connect-compatible identity provider, we recommend that you use Amazon
AssumeRoleWithWebIdentity. For more information, see Federation
Through a Web-based Identity Provider.
GetFederationToken action must be called by using the long-term AWS
security credentials of an IAM user. You can also call
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 the 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)
The permissions for the temporary security credentials returned by
are determined by a combination of the following:
The passed policy is attached to the temporary security credentials that result from
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
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
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. For information about using
to create temporary security credentials, see GetFederationToken—Federation
Through a Custom Identity Broker.
Version: (assembly version)
public virtual GetFederationTokenResponse GetFederationToken( GetFederationTokenRequest request )
Container for the necessary parameters to execute the GetFederationToken service method.
|MalformedPolicyDocumentException||The request was rejected because the policy document was malformed. The error message describes the specific error.|
|PackedPolicyTooLargeException||The request was rejected because the policy document was too large. The error message describes how big the policy document is, in packed form, as a percentage of what the API allows.|
|RegionDisabledException||STS is not activated in the requested region for the account that is being asked to create temporary credentials. The account administrator must activate STS in that region using the IAM Console. For more information, see Activating and Deactivating AWS STS in an AWS Region in the Using IAM.|
Supported in: 4.5, 4.0, 3.5