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.
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 AWS SDK for Android Developer Guide guide and Amazon Cognito Overview in the AWS SDK 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 for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the Using IAM.
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:
Namespace: Amazon.SecurityToken.Model
Assembly: AWSSDK.dll
Version: (assembly version)
public class AssumeRoleWithWebIdentityRequest : AmazonSecurityTokenServiceRequest IRequestEvents
The AssumeRoleWithWebIdentityRequest type exposes the following members
Name | Description | |
---|---|---|
AssumeRoleWithWebIdentityRequest() |
Name | Type | Description | |
---|---|---|---|
DurationSeconds | System.Int32 |
Gets and sets the property DurationSeconds.
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. |
|
Policy | System.String |
Gets and sets the property Policy.
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 the Using IAM. |
|
ProviderId | System.String |
Gets and sets the property ProviderId.
The fully qualified host component of the domain name of the identity provider.
Specify this value only for OAuth 2.0 access tokens. Currently Do not specify this value for OpenID Connect ID tokens. |
|
RoleArn | System.String |
Gets and sets the property RoleArn.
The Amazon Resource Name (ARN) of the role that the caller is assuming. |
|
RoleSessionName | System.String |
Gets and sets the property RoleSessionName.
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 |
|
WebIdentityToken | System.String |
Gets and sets the property WebIdentityToken.
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 |
.NET Framework:
Supported in: 4.5, 4.0, 3.5
.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8
.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8