As with most AWS features, you generally have two ways to use a role: interactively in the IAM console, or programmatically with the AWS CLI, Tools for Windows PowerShell, or API.
IAM users in your account using the IAM console can switch to a role to temporarily use the permissions of the role in the console. The users give up their original permissions and take on the permissions assigned to the role. When the users exit the role, their original permissions are restored.
An application or a service offered by AWS [like Amazon EC2] can assume a role by requesting temporary security credentials for a role with which to make programmatic requests to AWS. You use a role this way so that you don't have to share or maintain long-term security credentials [for example, by creating an IAM user] for each entity that requires access to a resource.
This guide uses the phrases switch to a role and assume a role interchangeably.
The simplest way to use roles is to grant your IAM users permissions to switch to roles that you create within your own or another AWS account. They can switch roles easily using the IAM console to use permissions that you don't ordinarily want them to have, and then exit the role to surrender those permissions. This can help prevent accidental access to or modification of sensitive resources.
For more complex uses of roles, such as granting access to applications and services, or federated external users, you can call the AssumeRole
API. This API call returns a set of temporary credentials that the application can use in subsequent API calls. Actions attempted with the temporary credentials have only the permissions granted by the associated role. An application doesn't have to "exit" the role the way a
user in the console does; rather the application simply stops using the temporary credentials and resumes making calls with the original credentials.
Federated users sign in by using credentials from an identity provider [IdP]. AWS then provides temporary credentials to the trusted IdP to pass on to the user for including in subsequent AWS resource requests. Those credentials provide the permissions granted to the assigned role.
This section provides overviews of the following scenarios:
Provide access for an IAM user in one AWS account that you own to access resources in another account that you own
Provide access to non AWS workloads
Provide access to IAM users in AWS accounts owned by third parties
Provide access for services offered by AWS to AWS resources
Provide access for externally authenticated users [identity federation]
Access to AWS Service Catalog requires credentials. Those credentials must have permission to access AWS resources, such as an AWS Service Catalog portfolio or product. AWS Service Catalog integrates with AWS Identity and Access Management [IAM] to enable you to grant AWS Service Catalog administrators the permissions they need to create and manage products, and to grant AWS Service Catalog end users the permissions they need to launch products and manage provisioned products. These policies are either created and managed by AWS or individually by administrators and end users. To control access, you attach these policies to the IAM users, groups, and roles that you use with AWS Service Catalog.
Topics
- Audience
- AWS Managed Policies for AWS Service Catalog
- Identity-based policy examples for AWS Service Catalog
- Troubleshooting AWS Service Catalog identity and access
- Controlling Access
Audience
The permissions you have with AWS Identity and Access Management [IAM] can depend on the role you play in AWS Service Catalog.
The permissions you have through AWS Identity and Access Management [IAM] can also depend on the role you play in AWS Service Catalog.
Administrator - As an AWS Service Catalog administrator, you need full access to the administrator console and IAM permissions that allow you to perform tasks such as creating and managing portfolios and products, managing constraints, and granting access to end users.
End user - Before your end users can use your products, you need to grant them permissions that give them access to the AWS Service Catalog end user console. They can also have permissions to launch products and manage provisioned products.
IAM administrator - If you're an IAM administrator, you might want to learn details about how you can write policies to manage access to AWS Service Catalog. To view example AWS Service Catalog identity-based policies that you can use in IAM, see AWS Managed Policies for AWS Service Catalog.
AWS Managed Policies for AWS Service Catalog
We recommend you use AWS managed policies to add permissions to users, groups, and roles. To create the appropriate IAM customer managed policies for your team requires an investment of time and product expertise. You can quickly start when you use our AWS managed policies. These policies cover common use cases and are available in your AWS account. For more information about AWS managed policies, see AWS managed policies in the IAM User Guide.
AWS services maintain and update AWS managed policies. You can't change the permissions in AWS managed policies. Services occasionally add additional permissions to an AWS managed policy to support new features. This type of update affects all identities [users, groups, and roles] where you find the policy. Services are most likely to update an AWS managed policy during a new feature launch or when new operations become available. Services do not remove permissions from an AWS managed policy, so policy updates won't break your existing permissions.
Additionally, AWS supports managed policies for job functions that span multiple services. For example, the ReadOnlyAccess AWS managed policy provides read-only access to all AWS services and resources. When a service launches a new feature, AWS adds read-only permissions for new operations and resources. For a list and descriptions of job function policies, see AWS managed policies for job functions in the IAM User Guide.
The managed policies created by AWS grant the required permissions for common use cases. You can attach these policies to your IAM users and roles. For more information, see AWS Managed Policies in the IAM User Guide.
The following are the AWS managed policies for AWS Service Catalog.
Administrators
AWSServiceCatalogAdminFullAccess — Grants full access to the administrator console view and permission to create and manage products and portfolios.
AWSServiceCatalogAdminReadOnlyAccess — Grants full access to the administrator console view. Does not grant access to create or manage products and portfolios.
AWSServiceCatalogEndUserFullAccess — Grants full access to the end user console view. Grants permission to launch products and manage provisioned products.
AWSServiceCatalogEndUserReadOnlyAccess — Grants read-only access to the end user console view. Does not grant permission to launch products or manage provisioned products.
To attach a policy to an IAM user, see Adding and removing IAM identity permissions in AWS Identity and Access Management User Guide.
Deprecated policies
The following managed policies are deprecated:
ServiceCatalogAdminFullAccess — Use AWSServiceCatalogAdminFullAccess instead.
ServiceCatalogAdminReadOnlyAccess — Use AWSServiceCatalogAdminReadOnlyAccess instead.
ServiceCatalogEndUserFullAccess — Use AWSServiceCatalogEndUserFullAccess instead.
ServiceCatalogEndUserAccess — Use AWSServiceCatalogEndUserReadOnlyAccess instead.
Use the following procedure to ensure that your administrators and end users are granted permissions using the current policies.
To migrate from the deprecated policies to the current policies, see Adding and removing IAM identity permissions in AWS Identity and Access Management User Guide.
Identity-based policy examples for AWS Service Catalog
Topics
- Console access for end users
- Product access for end users
- Example policies for managing provisioned products
Console access for end users
The AWSServiceCatalogEndUserFullAccess
and AWSServiceCatalogEndUserReadOnlyAccess
policies grant access to the AWS Service Catalog end user console view. When a user who has either of these policies chooses AWS Service Catalog in the AWS Management Console, the end user console view displays the products they have permission to launch.
Before end users can successfully launch a product from AWS Service Catalog to which you give access, you must provide them additional IAM permissions to allow them to use each of the underlying AWS resources in a product's AWS CloudFormation template. For example, if a product template includes Amazon Relational Database Service [Amazon RDS], you must grant the users Amazon RDS permissions to launch the product.
To learn about how to enable end users to launch products while enforcing least-access permissions to AWS resources, see Using AWS Service Catalog Constraints.
If you apply the AWSServiceCatalogEndUserReadOnlyAccess
policy, your users have access to the end user console, but they won't have the permissions that they need to launch products and manage provisioned products. You can grant these permissions directly to an end user using IAM, but if you want to limit the access that end users have to AWS resources, you
should attach the policy to a launch role. You then use AWS Service Catalog to apply the launch role to a launch constraint for the product. For more information about applying a launch role, launch role limitations, and a sample launch role, see AWS Service Catalog Launch Constraints.
If you grant users IAM permissions for AWS Service Catalog administrators, the administrator console view displays instead. Don't grant end users these permissions unless you want them to have access to the administrator console view.
Product access for end users
Before end users can use a product to which you give access, you must provide them additional IAM permissions to allow them to use each of the underlying AWS resources in a product's AWS CloudFormation template. For example, if a product template includes Amazon Relational Database Service [Amazon RDS], you must grant the users Amazon RDS permissions to launch the product.
If you apply the ServiceCatalogEndUserAccess policy, your users have access to the end user console view, but they won't have the permissions that they need to launch products and manage provisioned products. You can grant these permissions directly to an end user in IAM, but if you want to limit the access that end users have to AWS resources, you should attach the policy to a launch role. You then use AWS Service Catalog to apply the launch role to a launch constraint for the product. For more information about applying a launch role, launch role limitations, and a sample launch role, see AWS Service Catalog Launch Constraints.
Example policies for managing provisioned products
You can create custom
policies to help meet the security requirements of your organization. The following examples describe how to customize the access level for each action with support for user, role, and account levels. You can grant users access to view, update, terminate, and manage provisioned products created only by that user or created by others also under their role or the account to which they are logged in. This access is hierarchical — granting account level access also grants role level access and user
level access, while adding role level access also grants user level access but not account level access. You can specify these in the policy JSON using a Condition
block as accountLevel
, roleLevel
, or userLevel
.
These examples also apply to access levels for AWS Service Catalog API write operations: UpdateProvisionedProduct
and TerminateProvisionedProduct
, and read operations: DescribeRecord
, ScanProvisionedProducts
, and ListRecordHistory
. The ScanProvisionedProducts
and ListRecordHistory
API operations use AccessLevelFilterKey
as input, and that key's values correspond to the Condition
block
levels discussed here [accountLevel
is equivalent to an AccessLevelFilterKey
value of "Account", roleLevel
to "Role", and userLevel
to "User"]. For more information, see the AWS Service Catalog Developer Guide.
Examples
- Example: Full admin access to provisioned products
- Example: End-user access to provisioned products
- Example: Partial admin access to provisioned products
Example: Full admin access to provisioned products
The following policy allows full read and write access to provisioned products and records within the catalog at the account level.
{
"Version":"2012-10-17",
"Statement":[
{
"Effect":"Allow",
"Action":[
"servicecatalog:*"
],
"Resource":"*",
"Condition": {
"StringEquals": {
"servicecatalog:accountLevel": "self"
}
}
}
]
}
This policy is functionally equivalent to the following policy:
{
"Version":"2012-10-17",
"Statement":[
{
"Effect":"Allow",
"Action":[
"servicecatalog:*"
],
"Resource":"*"
}
]
}
In other words, not specifying a Condition
block in any policy for AWS Service Catalog is treated as the same as specifying "servicecatalog:accountLevel"
access. Note that accountLevel
access includes roleLevel
and userLevel
access.
Example: End-user access to provisioned products
The following policy restricts access to read and write operations to only the provisioned products or associated records that the current user created.
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"servicecatalog:DescribeProduct",
"servicecatalog:DescribeProductView",
"servicecatalog:DescribeProvisioningParameters",
"servicecatalog:DescribeRecord",
"servicecatalog:ListLaunchPaths",
"servicecatalog:ListRecordHistory",
"servicecatalog:ProvisionProduct",
"servicecatalog:ScanProvisionedProducts",
"servicecatalog:SearchProducts",
"servicecatalog:TerminateProvisionedProduct",
"servicecatalog:UpdateProvisionedProduct"
],
"Resource": "*",
"Condition": {
"StringEquals": {
"servicecatalog:userLevel": "self"
}
}
}
]
}
Example: Partial admin access to provisioned products
The two policies below, if both applied to the same user, allow what might be called a type of "partial admin access" by providing full read-only access and limited write access. This means the user can see any provisioned product or associated record within the catalog's account but cannot perform any actions on any provisioned products or records that aren't owned by that user.
The first policy allows the user access to write operations on the provisioned products that the current user created, but no provisioned products created by others. The second policy adds full access to read operations on provisioned products created by all [user, role, or account].
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"servicecatalog:DescribeProduct",
"servicecatalog:DescribeProductView",
"servicecatalog:DescribeProvisioningParameters",
"servicecatalog:ListLaunchPaths",
"servicecatalog:ProvisionProduct",
"servicecatalog:SearchProducts",
"servicecatalog:TerminateProvisionedProduct",
"servicecatalog:UpdateProvisionedProduct"
],
"Resource": "*",
"Condition": {
"StringEquals": {
"servicecatalog:userLevel": "self"
}
}
}
]
}
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"servicecatalog:DescribeRecord",
"servicecatalog:ListRecordHistory",
"servicecatalog:ScanProvisionedProducts"
],
"Resource": "*",
"Condition": {
"StringEquals": {
"servicecatalog:accountLevel": "self"
}
}
}
]
}
Troubleshooting AWS Service Catalog identity and access
Use the following information to help you diagnose and fix common issues you might encounter when working with AWS Service Catalog and IAM.
Topics
- I am not authorized to perform an action in AWS Service Catalog
- I am not authorized to perform iam:PassRole
- I want to view my access keys
- I'm an administrator and want to allow others to access AWS Service Catalog
- I want to allow people outside of my AWS account to access my AWS Service Catalog resources
I am not authorized to perform an action in AWS Service Catalog
If the AWS Management Console tells you that you're not authorized to perform an
action, then you must contact your administrator for assistance. Your administrator is the person that provided you with your user name and password. The following example error occurs when the mateojackson IAM user tries to use the console to view details about a fictional my-example-widget resource but does not have the fictional aws:GetWidget
permissions.
User: arn:aws:iam::123456789012:user/mateojackson is not authorized to perform: aws:GetWidget on resource: my-example-widget
In this case, Mateo asks his administrator to update his policies to allow him to access the my-example-widget
resource using the aws:GetWidget
action.
I am not authorized to perform iam:PassRole
If you receive an error that you're not authorized to perform the iam:PassRole
action, then you must contact your administrator for assistance. Your administrator is the person that provided you with your user name and password. Ask that person to update your policies to allow you to pass a role to AWS Service Catalog.
Some AWS services allow you to pass an existing role to that service, instead of creating a new service role or service-linked role. To do this, you must have permissions to pass the role to the service.
The following example error occurs when an IAM user named marymajor tries to use the console to perform an action in AWS Service Catalog. However, the action requires the service to have permissions granted by a service role. Mary does not have permissions to pass the role to the service.
User: arn:aws:iam::123456789012:user/marymajor is not authorized to perform: iam:PassRole
In this case, Mary asks her administrator to update her policies to allow her to perform the iam:PassRole action.
I want to view my access keys
After you create your IAM user access keys, you can view your access key ID at any time. However, you can't view your secret access key again. If you lose your secret key, you must create a new access key pair.
Access keys consist of two parts: an access key ID [for example, AKIAIOSFODNN7EXAMPLE] and a secret access key [for example, wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY].
Like a user name and password, you must use both the access key ID and secret access key together to authenticate your requests. Manage your access keys as securely as you do your user name and password.
Do not provide your access keys to a third party, even to help find your canonical user ID in the AWS General Reference guide. By doing this, you might give someone permanent access to your account.
When you create an access key pair, you are prompted to save the access key ID and secret access key in a secure location. The secret access key is available only at the time you create it. If you lose your secret access key, you must add new access keys to your IAM user. You can have a maximum of two access keys. If you already have two, you must delete one key pair before creating a new one. To view instructions, see Managing access keys in the IAM User Guide.
I'm an administrator and want to allow others to access AWS Service Catalog
To allow others to access AWS Service Catalog, you must create an IAM entity [user or role] for the person or application that needs access. They use the credentials for that entity to access AWS. You must then attach a policy to the entity that grants them the correct permissions in AWS Service Catalog.
To get started right away, see Creating your first IAM delegated user and group in the IAM User Guide.
I want to allow people outside of my AWS account to access my AWS Service Catalog resources
You can create a role that users in other accounts or people outside of your organization can use to access your resources. You can specify who is trusted to assume the role. For services that support resource-based policies or access control lists [ACLs], you can use those policies to grant people access to your resources.
To learn more, consult the following:
To learn whether AWS Service Catalog supports these features, see AWS Identity and Access Management in AWS Service Catalog in the AWS Service Catalog Administrator Guide.
To learn how to provide access to your resources across AWS accounts that you own, see Providing access to an IAM user in another AWS account that you own in the IAM User Guide.
To learn how to provide access to your resources to third-party AWS accounts, see Providing access to AWS accounts owned by third parties in the IAM User Guide.
To learn how to provide access through identity federation, see Providing access to externally authenticated users [identity federation] in the IAM User Guide.
To learn the difference between using roles and resource-based policies for cross-account access, see How IAM roles differ from resource-based policies in the IAM User Guide.
Controlling Access
An AWS Service Catalog portfolio gives your administrators a level of access control for your groups of end users. When you add users to a portfolio, they can browse and launch any of the products in the portfolio. For more information, see Managing Portfolios.
Constraints
Constraints control which rules are applied to your end users when launching a product from a specific portfolio. You use them to apply limits to products for governance or cost control. For more information about constraints, see Using AWS Service Catalog Constraints.
AWS Service Catalog launch constraints give you more control over permissions needed by an end user. When your administrator creates a launch constraint for a product in a portfolio, the launch constraint associates a role ARN that is used when your end users launch the product from that portfolio. Using this pattern, you can control access to AWS resource creation. For more information, see AWS Service Catalog Launch Constraints.