Network.AWS.STS.GetFederationToken

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 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.

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 Cognito or AssumeRoleWithWebIdentity. For more information, see Federation Through a Web-based Identity Provider.

The GetFederationToken action must be called by using the long-term AWS security credentials of an IAM user. You can also call 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 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)

Permissions

The permissions for the temporary security credentials returned by GetFederationToken are determined by a combination of the following:

• The policy or policies that are attached to the IAM user whose credentials are used to call GetFederationToken.
• The policy that is passed as a parameter in the call.

The passed policy is attached to the temporary security credentials that result from the 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 to call 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 GetFederationToken to create temporary security credentials, see GetFederationToken—Federation Through a Custom Identity Broker.

See: AWS API Reference for GetFederationToken.

Creating a Request

getFederationToken

Arguments

:: Text

gftName

-> GetFederationToken

Creates a value of GetFederationToken with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gftDurationSeconds
• gftPolicy
• gftName

data GetFederationToken

See: getFederationToken smart constructor.

Instances

Eq GetFederationToken

Data GetFederationToken

Read GetFederationToken

Show GetFederationToken

Generic GetFederationToken

AWSRequest GetFederationToken

ToPath GetFederationToken

ToHeaders GetFederationToken

ToQuery GetFederationToken

type Rep GetFederationToken

type Rs GetFederationToken = GetFederationTokenResponse

Request Lenses

gftDurationSeconds :: Lens' GetFederationToken (Maybe Natural)

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.

gftPolicy :: Lens' GetFederationToken (Maybe Text)

An IAM policy in JSON format that is passed with the GetFederationToken call and evaluated along with the policy or policies that are attached to the IAM user whose credentials are used to call 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.

The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size.

For more information about how permissions work, see Permissions for GetFederationToken.

gftName :: Lens' GetFederationToken Text

The name of the federated user. The name is used as an identifier for the temporary security credentials (such as Bob). For example, you can reference the federated user name in a resource-based policy, such as in an Amazon S3 bucket policy.

Destructuring the Response

getFederationTokenResponse

Arguments

:: Int

gftrsResponseStatus

-> GetFederationTokenResponse

Creates a value of GetFederationTokenResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gftrsPackedPolicySize
• gftrsCredentials
• gftrsFederatedUser
• gftrsResponseStatus

data GetFederationTokenResponse

Contains the response to a successful GetFederationToken request, including temporary AWS credentials that can be used to make AWS requests.

See: getFederationTokenResponse smart constructor.

Instances

Eq GetFederationTokenResponse

Data GetFederationTokenResponse

Read GetFederationTokenResponse

Show GetFederationTokenResponse

Generic GetFederationTokenResponse

type Rep GetFederationTokenResponse

Response Lenses

gftrsPackedPolicySize :: Lens' GetFederationTokenResponse (Maybe Natural)

A percentage value indicating the size of the policy in packed form. The service rejects policies for which the packed size is greater than 100 percent of the allowed value.

gftrsCredentials :: Lens' GetFederationTokenResponse (Maybe Credentials)

Credentials for the service API authentication.

gftrsFederatedUser :: Lens' GetFederationTokenResponse (Maybe FederatedUser)

Identifiers for the federated user associated with the credentials (such as 'arn:aws:sts::123456789012:federated-user\/Bob' or '123456789012:Bob'). You can use the federated user's ARN in your resource-based policies, such as an Amazon S3 bucket policy.

gftrsResponseStatus :: Lens' GetFederationTokenResponse Int

The response status code.