Network.AWS.STS.AssumeRoleWithWebIdentity

Returns a set of temporary security credentials for users who have been authenticated in a mobile or web application with a web identity provider, such as Amazon Cognito, Login with Amazon, Facebook, Google, or any OpenID Connect-compatible identity provider.

For mobile applications, we recommend that you use Amazon Cognito. You can use Amazon Cognito with the AWS SDK for iOS and the AWS SDK for Android to uniquely identify a user and supply the user with a consistent identity throughout the lifetime of an application.

To learn more about Amazon Cognito, see Amazon Cognito Overview in the AWSSDK for Android Developer Guide guide and Amazon Cognito Overview in the AWSSDK for iOS Developer Guide.

Calling AssumeRoleWithWebIdentity does not require the use of AWS security credentials. Therefore, you can distribute an application (for example, on mobile devices) that requests temporary security credentials without including long-term AWS credentials in the application, and without deploying server-based proxy services that use long-term AWS credentials. Instead, the identity of the caller is validated by using a token from the web identity provider.

The temporary security credentials returned by this API consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS service APIs. The credentials are valid for the duration that you specified when calling AssumeRoleWithWebIdentity, which can be from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the temporary security credentials are valid for 1 hour.

Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a policy, the temporary security credentials that are returned by the operation have the permissions that are defined in the access policy of the role that is being assumed. If you pass a policy to this operation, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see Permissions forAssumeRoleWithWebIdentity in Using Temporary Security Credentials.

Before your application can call AssumeRoleWithWebIdentity, you must have an identity token from a supported identity provider and create a role that the application can assume. The role that your application assumes must trust the identity provider that is associated with the identity token. In other words, the identity provider must be specified in the role's trust policy.

For more information about how to use web identity federation and the AssumeRoleWithWebIdentity API, see the following resources:

Creating a Mobile Application with Third-Party Sign-In and CreatingTemporary Security Credentials for Mobile Apps Using Third-Party IdentityProviders in Using Temporary Security Credentials. Web Identity FederationPlayground. This interactive website lets you walk through the process of authenticating via Login with Amazon, Facebook, or Google, getting temporary security credentials, and then using those credentials to make a request to AWS. AWS SDK for iOS and AWS SDK for Android. These toolkits contain sample apps that show how to invoke the identity providers, and then how to use the information from these providers to get and use temporary security credentials. Web Identity Federation with Mobile Applications. This article discusses web identity federation and shows an example of how to use web identity federation to get access to content in Amazon S3.

http://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html

Request

data AssumeRoleWithWebIdentity

Instances

Eq AssumeRoleWithWebIdentity

Ord AssumeRoleWithWebIdentity

Read AssumeRoleWithWebIdentity

Show AssumeRoleWithWebIdentity

AWSRequest AssumeRoleWithWebIdentity

ToQuery AssumeRoleWithWebIdentity

ToHeaders AssumeRoleWithWebIdentity

ToPath AssumeRoleWithWebIdentity

type Rs AssumeRoleWithWebIdentity = AssumeRoleWithWebIdentityResponse

type Sv AssumeRoleWithWebIdentity = STS

Request constructor

assumeRoleWithWebIdentity

Arguments

:: Text

arwwiRoleArn

-> Text

arwwiRoleSessionName

-> Text

arwwiWebIdentityToken

-> AssumeRoleWithWebIdentity

AssumeRoleWithWebIdentity constructor.

The fields accessible through corresponding lenses are:

• arwwiDurationSeconds :: Maybe Natural
• arwwiPolicy :: Maybe Text
• arwwiProviderId :: Maybe Text
• arwwiRoleArn :: Text
• arwwiRoleSessionName :: Text
• arwwiWebIdentityToken :: Text

Request lenses

arwwiDurationSeconds :: Lens' AssumeRoleWithWebIdentity (Maybe Natural)

The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.

arwwiPolicy :: Lens' AssumeRoleWithWebIdentity (Maybe Text)

An IAM policy in JSON format.

The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see Permissions for AssumeRoleWithWebIdentity in Using Temporary SecurityCredentials.

arwwiProviderId :: Lens' AssumeRoleWithWebIdentity (Maybe Text)

The fully qualified host component of the domain name of the identity provider.

Specify this value only for OAuth 2.0 access tokens. Currently 'www.amazon.com' and 'graph.facebook.com' are the only supported identity providers for OAuth 2.0 access tokens. Do not include URL schemes and port numbers.

Do not specify this value for OpenID Connect ID tokens.

arwwiRoleArn :: Lens' AssumeRoleWithWebIdentity Text

The Amazon Resource Name (ARN) of the role that the caller is assuming.

arwwiRoleSessionName :: Lens' AssumeRoleWithWebIdentity Text

An identifier for the assumed role session. Typically, you pass the name or identifier that is associated with the user who is using your application. That way, the temporary security credentials that your application will use are associated with that user. This session name is included as part of the ARN and assumed role ID in the AssumedRoleUser response element.

arwwiWebIdentityToken :: Lens' AssumeRoleWithWebIdentity Text

The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity provider. Your application must get this token by authenticating the user who is using your application with a web identity provider before the application makes an AssumeRoleWithWebIdentity call.

Response

data AssumeRoleWithWebIdentityResponse

Instances

Eq AssumeRoleWithWebIdentityResponse

Read AssumeRoleWithWebIdentityResponse

Show AssumeRoleWithWebIdentityResponse

FromXML AssumeRoleWithWebIdentityResponse

Response constructor

assumeRoleWithWebIdentityResponse :: AssumeRoleWithWebIdentityResponse

AssumeRoleWithWebIdentityResponse constructor.

The fields accessible through corresponding lenses are:

• arwwirAssumedRoleUser :: Maybe AssumedRoleUser
• arwwirAudience :: Maybe Text
• arwwirCredentials :: Maybe Credentials
• arwwirPackedPolicySize :: Maybe Natural
• arwwirProvider :: Maybe Text
• arwwirSubjectFromWebIdentityToken :: Maybe Text

Response lenses

arwwirAssumedRoleUser :: Lens' AssumeRoleWithWebIdentityResponse (Maybe AssumedRoleUser)

The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the RoleSessionName that you specified when you called AssumeRole.

arwwirAudience :: Lens' AssumeRoleWithWebIdentityResponse (Maybe Text)

The intended audience (also known as client ID) of the web identity token. This is traditionally the client identifier issued to the application that requested the web identity token.

arwwirCredentials :: Lens' AssumeRoleWithWebIdentityResponse (Maybe Credentials)

The temporary security credentials, which include an access key ID, a secret access key, and a security token.

arwwirPackedPolicySize :: Lens' AssumeRoleWithWebIdentityResponse (Maybe Natural)

A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.

arwwirProvider :: Lens' AssumeRoleWithWebIdentityResponse (Maybe Text)

The issuing authority of the web identity token presented. For OpenID Connect ID Tokens this contains the value of the iss field. For OAuth 2.0 access tokens, this contains the value of the ProviderId parameter that was passed in the AssumeRoleWithWebIdentity request.

arwwirSubjectFromWebIdentityToken :: Lens' AssumeRoleWithWebIdentityResponse (Maybe Text)

The unique user identifier that is returned by the identity provider. This identifier is associated with the WebIdentityToken that was submitted with the AssumeRoleWithWebIdentity call. The identifier is typically unique to the user and the application that acquired the WebIdentityToken (pairwise identifier). For OpenID Connect ID tokens, this field contains the value returned by the identity provider as the token's sub (Subject) claim.