Permissions and Supported Actions
This chapter describes fine-grained permissions management for your RFS resources. If your account does not need individual IAM users, you can skip the operations in this chapter.
By default, new IAM users do not have permissions assigned. You need to add a user to one or more groups, and attach permissions policies or roles to these groups. Users inherit permissions from the groups to which they are added and can perform specified operations on cloud services based on the permissions.
You can grant users permissions by using . Roles are a type of service-based, coarse-grained authorization mechanism provided by IAM to define permissions that match user responsibilities. Policies define API-based permissions for operations on specific resources under certain conditions, allowing for more fine-grained, secure access control of cloud resources.
Policy-based authorization is useful if you want to allow or deny the access to an API.
An account has all the permissions required to call all APIs, but IAM users must be assigned the permissions to call the required APIs. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions can call the API successfully. For example, if an IAM user wants to query ECSs using an API, the user must have been granted permissions that allow the ecs:servers:list action.
Supported Actions in IAM
RFS provides system-defined policies that can be directly used in IAM. You can also create custom policies to supplement system-defined policies for more refined access control. Operations supported by policies are specific to APIs. The following are common concepts related to policies:
- Permission: a statement in a policy that allows or denies certain operations.
- APIs: APIs that can be called in a custom policy.
- Actions: specific operations that are allowed or denied in a custom policy.
- Dependencies: actions which a specific action depends on. When allowing an action for a user, you also need to allow any existing action dependencies for that user.
- IAM projects/Enterprise projects: the authorization scope of a custom policy. A custom policy can be applied to IAM projects or enterprise projects or both. Policies that contain actions supporting both IAM and enterprise projects can be assigned to user groups and take effect in both IAM and Enterprise Management. Policies that only contain actions supporting IAM projects can be assigned to user groups and only take effect for IAM. Such policies will not take effect if they are assigned to user groups in enterprise management.
The check mark (√) and cross symbol (x) respectively indicate that an action takes effect or does not take effect for the corresponding type of projects.
RFS supports the following actions in custom policies.
| Permission | API | Action | IAM Project | Enterprise Project |
|---|---|---|---|---|
| Create private templates | POST /v1/{project_id}/templates | rf:privateTemplate:create | √ | x |
| Create a private template version | POST /v1/{project_id}/templates/{template_name}/versions | rf:privateTemplate:createVersion | √ | x |
| Delete a private template | DELETE /v1/{project_id}/templates/{template_name} | rf:privateTemplate:delete | √ | x |
| Delete a private template version | DELETE /v1/{project_id}/templates/{template_name}/versions/{version_id} | rf:privateTemplate:deleteVersion | √ | x |
| List all private templates in a project | GET /v1/{project_id}/templates | rf:privateTemplate:list | √ | x |
| Display all versions of a private template | GET /v1/{project_id}/templates/{template_name}/versions | rf:privateTemplate:listVersions | √ | x |
| Display private template metadata | GET /v1/{project_id}/templates/{template_name}/metadata | rf:privateTemplate:showMetadata | √ | x |
| Obtain the content of a private template version | GET /v1/{project_id}/templates/{template_name}/versions/{version_id} | rf:privateTemplate:showVersionContent | √ | x |
| Obtain the metadata of a private template version | GET /v1/{project_id}/templates/{template_name}/versions/{version_id}/metadata | rf:privateTemplate:showVersionMetadata | √ | x |
| Update the metadata of a private template | PATCH /v1/{project_id}/templates/{template_name}/metadata | rf:privateTemplate:updateMetadata | √ | x |
| Permission | API | Action | IAM Project | Enterprise Project |
|---|---|---|---|---|
| Apply an execution plan | POST /v1/{project_id}/stacks/{stack_name}/execution-plans/{execution_plan_name} | rf:stack:applyExecutionPlan | √ | x |
| Continue to deploy a stack | POST /v1/{project_id}/stacks/{stack_name}/continuations | rf:stack:continueDeployStack | √ | x |
| Continue to roll back a stack | POST /v1/{project_id}/stacks/{stack_name}/rollbacks | rf:stack:continueRollbackStack | √ | x |
| Create an execution plan | POST /v1/{project_id}/stacks/{stack_name}/execution-plans | rf:stack:createExecutionPlan | √ | x |
| Create a stack | POST /v1/{project_id}/stacks | rf:stack:createStack | √ | x |
| Delete an execution plan | DELETE /v1/{project_id}/stacks/{stack_name}/execution-plans/{execution_plan_name} | rf:stack:deleteExecutionPlan | √ | x |
| Delete a stack | DELETE /v1/{project_id}/stacks/{stack_name} | rf:stack:deleteStack | √ | x |
| Delete a stack with conditions | POST /v1/{project_id}/stacks/{stack_name}/deletion | rf:stack:deleteStack | √ | x |
| Deploy a stack | POST /v1/{project_id}/stacks/{stack_name}/deployments | rf:stack:deployStack | √ | x |
| Estimate the price of an execution plan | GET /v1/{project_id}/stacks/{stack_name}/execution-plans/{execution_plan_name}/prices | rf:stack:estimateExecutionPlanPrice | √ | x |
| Obtain execution plans | GET /v1/{project_id}/stacks/{stack_name}/execution-plans/{execution_plan_name} | rf:stack:getExecutionPlan | √ | x |
| Obtain execution plan metadata | GET /v1/{project_id}/stacks/{stack_name}/execution-plans/{execution_plan_name}/metadata | rf:stack:getExecutionPlanMetadata | √ | x |
| Obtain stack metadata | GET /v1/{project_id}/stacks/{stack_name}/metadata | rf:stack:getStackMetadata | √ | x |
| Obtain a stack template | GET /v1/{project_id}/stacks/{stack_name}/templates | rf:stack:getStackTemplate | √ | x |
| Query execution plans | GET /v1/{project_id}/stacks/{stack_name}/execution-plans | rf:stack:listExecutionPlans | √ | x |
| Query deployment events of a stack | GET /v1/{project_id}/stacks/{stack_name}/events | rf:stack:listStackEvents | √ | x |
| Query stack outputs | GET /v1/{project_id}/stacks/{stack_name}/outputs | rf:stack:listStackOutputs | √ | x |
| Query stack resources | GET /v1/{project_id}/stacks/{stack_name}/resources | rf:stack:listStackResources | √ | x |
| Query stacks | GET /v1/{project_id}/stacks | rf:stack:listStacks | √ | x |
| Update a stack | PATCH /v1/{project_id}/stacks/{stack_name} | rf:stack:updateStack | √ | x |
| Permission | API | Action | IAM Project | Enterprise Project |
|---|---|---|---|---|
| Create a stack set | POST /v1/stack-sets | rf:stackSet:create | √ | x |
| Create stack instances | POST /v1/stack-sets/{stack_set_name}/stack-instances | rf:stackSet:createStackInstances | √ | x |
| Delete a stack set | DELETE /v1/stack-sets/{stack_set_name} | rf:stackSet:delete | √ | x |
| Delete stack instances | DELETE /v1/stack-sets/{stack_set_name}/stack-instances | rf:stackSet:deleteStackInstances | √ | x |
| Deploy a stack set | POST /v1/stack-sets/{stack_set_name}/deployments | rf:stackSet:deploy | √ | x |
| Query stack sets | GET /v1/stack-sets | rf:stackSet:list | √ | x |
| Query stack set operations | GET /v1/stack-sets/{stack_set_name}/operations | rf:stackSet:listOperations | √ | x |
| Query stack instances | GET /v1/stack-sets/{stack_set_name}/stack-instances | rf:stackSet:listStackInstances | √ | x |
| Obtain metadata of a stack set | GET /v1/stack-sets/{stack_set_name}/metadata | rf:stackSet:showMetadata | √ | x |
| Obtain metadata of a stack set operation | GET /v1/stack-sets/{stack_set_name}/operations/{stack_set_operation_id}/metadata | rf:stackSet:showOperationMetadata | √ | x |
| Obtain a stack instance | GET /v1/stack-sets/{stack_set_name}/stack-instances/{stack_instance_addr} | rf:stackSet:showStackInstance | √ | x |
| Obtain a stack set template | GET /v1/stack-sets/{stack_set_name}/templates | rf:stackSet:showTemplate | √ | x |
| Update a stack set | PATCH /v1/stack-sets/{stack_set_name} | rf:stackSet:update | √ | x |
| Update stack instances | PATCH /v1/stack-sets/{stack_set_name}/stack-instances | rf:stackSet:updateStackInstances | √ | x |
| Permission | API | Action | IAM Project | Enterprise Project |
|---|---|---|---|---|
| Parse template parameters | POST /v1/{project_id}/template-analyses/variables | rf:template:parseTemplateVariables | √ | x |
| Permission | API | Action | IAM Project | Enterprise Project |
|---|---|---|---|---|
| Create a private module | POST /v1/private-modules | rf:privateModule:create | √ | x |
| List private modules | GET /v1/private-modules | rf:privateModule:list | √ | x |
| Delete a private module | DELETE /v1/private-modules/{module_name} | rf:privateModule:delete | √ | x |
| Show private module metadata | GET /v1/private-modules/{module_name}/metadata | rf:privateModule:showMetadata | √ | x |
| Update private module metadata | PATCH /v1/private-modules/{module_name}/metadata | rf:privateModule:updateMetadata | √ | x |
| Create a private module version | POST /v1/private-modules/{module_name}/versions | rf:privateModule:createVersion | √ | x |
| List private module versions | GET /v1/private-modules/{module_name}/versions | rf:privateModule:listVersions | √ | x |
| Show private module version content | GET /v1/private-modules/{module_name}/versions/{module_version} | rf:privateModule:showVersionContent | √ | x |
| Show private module version metadata | GET /v1/private-modules/{module_name}/versions/{module_version}/metadata | rf:privateModule:showVersionMetadata | √ | x |
| Delete a private module version | DELETE /v1/private-modules/{module_name}/versions/{module_version} | rf:privateModule:deleteVersion | √ | x |
| Permission | API | Action | IAM Project | Enterprise Project |
|---|---|---|---|---|
| Create a private provider | POST /v1/private-providers | rf:privateProvider:create | √ | x |
| List private providers | GET /v1/private-providers | rf:privateProvider:list | √ | x |
| Delete a private provider | DELETE /v1/private-providers/{provider_name} | rf:privateProvider:delete | √ | x |
| Show private provider metadata | GET /v1/private-providers/{provider_name}/metadata | rf:privateProvider:showMetadata | √ | x |
| Update private provider metadata | PATCH /v1/private-providers/{provider_name}/metadata | rf:privateProvider:updateMetadata | √ | x |
| Create a private provider version | POST /v1/private-providers/{provider_name}/versions | rf:privateProvider:createVersion | √ | x |
| List private provider versions | GET /v1/private-providers/{provider_name}/versions | rf:privateProvider:listVersions | √ | x |
| Show private provider version metadata | GET /v1/private-providers/{provider_name}/versions/{provider_version}/metadata | rf:privateProvider:showVersionMetadata | √ | x |
| Delete a private provider version | DELETE /v1/private-providers/{provider_name}/versions/{provider_version} | rf:privateProvider:deleteVersion | √ | x |
| Permission | API | Action | IAM Project | Enterprise Project |
|---|---|---|---|---|
| Create a private hook | POST /v1/private-hooks | rf:privateHook:create | √ | x |
| List private hooks | GET /v1/private-hooks | rf:privateHook:list | √ | x |
| Delete a private hook | DELETE /v1/private-hooks/{hook_name} | rf:privateHook:delete | √ | x |
| Show private hook metadata | GET /v1/private-hooks/{hook_name}/metadata | rf:privateHook:showMetadata | √ | x |
| Update private hook metadata | PATCH /v1/private-hooks/{hook_name}/metadata | rf:privateHook:updateMetadata | √ | x |
| Create a private hook version | POST /v1/private-hooks/{hook_name}/versions | rf:privateHook:createVersion | √ | x |
| List private hook versions | GET /v1/private-hooks/{hook_name}/versions | rf:privateHook:listVersions | √ | x |
| Show private hook version metadata | GET /v1/private-hooks/{hook_name}/versions/{hook_version}/metadata | rf:privateHook:showVersionMetadata | √ | x |
| Show private hook version policy | GET /v1/private-hooks/{hook_name}/versions/{hook_version}/policies | rf:privateHook:showVersionPolicy | √ | x |
| Delete a private hook version | DELETE /v1/private-hooks/{hook_name}/versions/{hook_version} | rf:privateHook:deleteVersion | √ | x |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
