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.
The AWS Security Token Service (STS) is a web service that enables you to request temporary, limited-privilege credentials for AWS Identity and Access Management (IAM) users or for users that you authenticate (federated users). This guide provides descriptions of the STS API. For more detailed information about using this service, go to Temporary Security Credentials.
For information about setting up signatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information about the Query API, go to Making Query Requests in Using IAM. For information about using security tokens with other AWS products, go to AWS Services That Work with IAM in the Using IAM.
If you're new to AWS and need additional technical information about a specific AWS product, you can find the product's technical documentation at http://aws.amazon.com/documentation/.
Endpoints
The AWS Security Token Service (STS) has a default endpoint of https://sts.amazonaws.com that maps to the US East (N. Virginia) region. Additional regions are available, but must first be activated in the AWS Management Console before you can use a different region's endpoint. For more information about activating a region for STS see Activating STS in a New Region in the Using IAM.
For information about STS endpoints, see Regions and Endpoints in the AWS General Reference.
Recording API requests
STS supports AWS CloudTrail, which is a service that records AWS calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine what requests were successfully made to STS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.
Namespace: Amazon.SecurityToken
Assembly: AWSSDK.dll
Version: (assembly version)
public interface IAmazonSecurityTokenService IDisposable
The IAmazonSecurityTokenService type exposes the following members
Name | Description | |
---|---|---|
AssumeRole(AssumeRoleRequest) |
Returns a set of temporary security credentials (consisting of an access key ID, a
secret access key, and a security token) that you can use to access AWS resources
that you might not normally have access to. Typically, you use AssumeRole
for cross-account access or federation.
Important: You cannot call For cross-account access, imagine that you own multiple accounts and need to access resources in each account. You could create long-term credentials in each account to access those resources. However, managing all those credentials and remembering which one can access which account can be time consuming. Instead, you can create one set of long-term credentials in one account and then use temporary security credentials to access all the other accounts by assuming roles in those accounts. For more information about roles, see IAM Roles (Delegation and Federation) in the Using IAM.
For federation, you can, for example, grant single sign-on access to the AWS Management
Console. If you already have an identity and authentication system in your corporate
network, you don't have to recreate user identities in AWS in order to grant those
user identities access to AWS. Instead, after a user has been authenticated, you call
The temporary security credentials are valid for the duration that you specified when
calling 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.
To assume a role, your AWS account must be trusted by the role. The trust relationship
is defined in the role's trust policy when the role is created. You must also have
a policy that allows you to call Using MFA with AssumeRole
You can optionally include multi-factor authentication (MFA) information when you
call
For more information, see Configuring MFA-Protected API Access in the Using IAM guide.
To use MFA with |
|
AssumeRoleAsync(AssumeRoleRequest, CancellationToken) | Initiates the asynchronous execution of the AssumeRole operation. | |
AssumeRoleWithSAML(AssumeRoleWithSAMLRequest) |
Returns a set of temporary security credentials for users who have been authenticated
via a SAML authentication response. This operation provides a mechanism for tying
an enterprise identity store or directory to role-based AWS access without user-specific
credentials or configuration.
The temporary security credentials returned by this operation 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 services. The credentials are valid for
the duration that you specified when calling 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
Calling For more information, see the following resources:
|
|
AssumeRoleWithSAMLAsync(AssumeRoleWithSAMLRequest, CancellationToken) | Initiates the asynchronous execution of the AssumeRoleWithSAML operation. | |
AssumeRoleWithWebIdentity(AssumeRoleWithWebIdentityRequest) |
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 AWS SDK for Android Developer Guide guide and Amazon Cognito Overview in the AWS SDK for iOS Developer Guide.
Calling
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 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
For more information about how to use web identity federation and the
|
|
AssumeRoleWithWebIdentityAsync(AssumeRoleWithWebIdentityRequest, CancellationToken) | Initiates the asynchronous execution of the AssumeRoleWithWebIdentity operation. | |
DecodeAuthorizationMessage(DecodeAuthorizationMessageRequest) |
Decodes additional information about the authorization status of a request from an
encoded message returned in response to an AWS request.
For example, if a user is not authorized to perform an action that he or she has requested,
the request returns a
The message is encoded because the details of the authorization status can constitute
privileged information that the user who requested the action should not see. To decode
an authorization status message, a user must be granted permissions via an IAM policy
to request the The decoded message includes the following type of information:
|
|
DecodeAuthorizationMessageAsync(DecodeAuthorizationMessageRequest, CancellationToken) | Initiates the asynchronous execution of the DecodeAuthorizationMessage operation. | |
GetFederationToken(GetFederationTokenRequest) |
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
The 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
The passed policy is attached to the temporary security credentials that result from
the
A typical use case is that the permissions of the IAM user whose credentials are used
to call 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 |
|
GetFederationTokenAsync(GetFederationTokenRequest, CancellationToken) | Initiates the asynchronous execution of the GetFederationToken operation. | |
GetSessionToken() |
Returns a set of temporary credentials for an AWS account or IAM user. The credentials
consist of an access key ID, a secret access key, and a security token. Typically,
you use GetSessionToken if you want to use MFA to protect programmatic
calls to specific AWS APIs like Amazon EC2 StopInstances . MFA-enabled
IAM users would need to call GetSessionToken and submit an MFA code that
is associated with their MFA device. Using the temporary security credentials that
are returned from the call, IAM users can then make programmatic calls to APIs that
require MFA authentication. If you do not supply a correct MFA code, then the API
returns an access denied error.
The
We recommend that you do not call
The permissions associated with the temporary security credentials returned by
For more information about using |
|
GetSessionToken(GetSessionTokenRequest) |
Returns a set of temporary credentials for an AWS account or IAM user. The credentials
consist of an access key ID, a secret access key, and a security token. Typically,
you use GetSessionToken if you want to use MFA to protect programmatic
calls to specific AWS APIs like Amazon EC2 StopInstances . MFA-enabled
IAM users would need to call GetSessionToken and submit an MFA code that
is associated with their MFA device. Using the temporary security credentials that
are returned from the call, IAM users can then make programmatic calls to APIs that
require MFA authentication. If you do not supply a correct MFA code, then the API
returns an access denied error.
The
We recommend that you do not call
The permissions associated with the temporary security credentials returned by
For more information about using |
|
GetSessionTokenAsync(GetSessionTokenRequest, CancellationToken) | Initiates the asynchronous execution of the GetSessionToken operation. |
.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