GetFederationTokenRequest (AWS SDK for Android

Overview

Package

Class

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.amazonaws.services.securitytoken.model
Class GetFederationTokenRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.securitytoken.model.GetFederationTokenRequest

All Implemented Interfaces:: java.io.Serializable

public class GetFederationTokenRequest
extends AmazonWebServiceRequest
implements java.io.Serializable
extends AmazonWebServiceRequest
implements java.io.Serializable

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

See Also:: AWSSecurityTokenService.getFederationToken(GetFederationTokenRequest), Serialized Form

Constructor Summary
`GetFederationTokenRequest()` Default constructor for a new GetFederationTokenRequest object.
`GetFederationTokenRequest(java.lang.String name)` Constructs a new GetFederationTokenRequest object.

Method Summary
`boolean`	`equals(java.lang.Object obj)`
`java.lang.Integer`	`getDurationSeconds()` The duration, in seconds, that the session should last.
`java.lang.String`	`getName()` The name of the federated user.
`java.lang.String`	`getPolicy()` 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`.
`int`	`hashCode()`
`void`	`setDurationSeconds(java.lang.Integer durationSeconds)` The duration, in seconds, that the session should last.
`void`	`setName(java.lang.String name)` The name of the federated user.
`void`	`setPolicy(java.lang.String policy)` 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`.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`GetFederationTokenRequest`	`withDurationSeconds(java.lang.Integer durationSeconds)` The duration, in seconds, that the session should last.
`GetFederationTokenRequest`	`withName(java.lang.String name)` The name of the federated user.
`GetFederationTokenRequest`	`withPolicy(java.lang.String policy)` 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`.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
`copyPrivateRequestParameters, getDelegationToken, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setDelegationToken, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector`

Methods inherited from class java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`

Constructor Detail

GetFederationTokenRequest

public GetFederationTokenRequest()

Default constructor for a new GetFederationTokenRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

GetFederationTokenRequest

public GetFederationTokenRequest(java.lang.String name)

Constructs a new GetFederationTokenRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:: name - 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.

Method Detail

getName

public java.lang.String getName()

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.

Constraints:
Length: 2 - 32
Pattern: [\w+=,.@-]*

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

setName

public void setName(java.lang.String name)

Constraints:
Length: 2 - 32
Pattern: [\w+=,.@-]*

Parameters:: name - 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.

withName

public GetFederationTokenRequest withName(java.lang.String name)

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

Constraints:
Length: 2 - 32
Pattern: [\w+=,.@-]*

Parameters:: name - 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.
Returns:: A reference to this updated object so that method calls can be chained together.

getPolicy

public java.lang.String getPolicy()

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.