Updated on 2025-11-06 GMT+08:00

Key Pair Service (KPS)

IAM provides system-defined identity policies to define typical cloud service permissions. You can also create custom identity policies using the actions supported by cloud services for more refined access control.

In addition to IAM, the Organizations service also provides Service Control Policies (SCPs) to set access control policies.

SCPs do not actually grant any permissions to an entity. They only set the permissions boundary for the entity. When SCPs are attached to an organizational unit (OU) or a member account, the SCPs do not directly grant permissions to that OU or member account. Instead, the SCPs only determine what permissions are available for that member account or those member accounts under that OU. The granted permissions can be applied only if they are allowed by the SCPs.

To learn more about how IAM is different from Organizations for access control, see How IAM Is Different from Organizations for Access Control?.

This section describes the elements used by IAM custom identity policies and Organizations SCPs. The elements include actions, resources, and conditions.

Actions

Actions are specific operations that are allowed or denied in an identity policy.

  • The Access Level column describes how the action is classified (List, Read, or Write). This classification helps you understand the level of access that an action grants when you use it in an identity policy.
  • The Resource Type column indicates whether the action supports resource-level permissions.
    • You can use a wildcard (*) to indicate all resource types. If this column is empty (-), the action does not support resource-level permissions and you must specify all resources ("*") in your identity policy statements.
    • If this column includes a resource type, you must specify the URN in the Resource element of your identity policy statements.
    • Required resources are marked with asterisks (*) in the table. If you specify a resource in a statement using this action, then it must be of this type.

    For details about the resource types defined by KPS, see Resources.

  • The Condition Key column contains keys that you can specify in the Condition element of an identity policy statement.
    • If the Resource Type column has values for an action, the condition key takes effect only for the listed resource types.
    • If the Resource Type column is empty (-) for an action, the condition key takes effect for all resources that action supports.
    • If the Condition Key column is empty (-) for an action, the action does not support any condition keys.

    For details about the condition keys defined by KPS, see Conditions.

  • The Alias column lists the policy actions that are configured in identity policies. With these actions, you can use APIs for policy-based authorization. For details, see Policies and Identity Policies.

The following table lists the actions that you can define in identity policy statements for KPS.

Table 1 Actions supported by KPS

Action

Description

Access Level

Resource Type (*: required)

Condition Key

Alias

kps:SSHKeyPair:create

Grants permission to create and import an SSH key pair.

Write

SSHKeyPair *

  • kps:domainKeypairs:create

kps:SSHKeyPair:delete

Grants permission to delete an SSH key pair.

Write

SSHKeyPair *

-

  • kps:domainKeypairs:delete

kps:SSHKeyPair:get

Grants permission to query the details about an SSH key pair.

Read

SSHKeyPair *

-

  • kps:domainKeypairs:get

kps:SSHKeyPair:list

Grants permission to query the SSH key pairs list.

List

SSHKeyPair *

-

  • kps:domainKeypairs:list

kps:SSHKeyPair:update

Grants permission to update the description of an SSH key pair.

Write

SSHKeyPair *

-

  • kps:domainKeypairs:update

kps:SSHKeyPair:bind

Grants permission to bind ECS to a new SSH key pair.

Write

SSHKeyPair *

-

  • kps:domainKeypairs:bind

kps::deleteFailedTask

Grants permission to delete failed tasks.

Write

-

-

  • kps:domainKeypairs:deletefailtask
  • kps:domainKeypairs:deletefailtasks

kps:SSHKeyPair:unbind

Grants permission to unbind ECS from an SSH key pair.

Write

SSHKeyPair *

-

  • kps:domainKeypairs:unbind
  • ecs:serverKeypairs:unbind

kps::getFailedTask

Grants permission to query information about failed tasks.

List

-

-

  • kps:domainKeypairs:getfailtask

kps::getTask

Grants permission to query the current task execution status.

List

-

-

  • kps:domainKeypairs:gettask

kps::getRunningTask

Grants permission to query information about ongoing tasks.

List

-

-

  • kps:domainKeypairs:getrunningtask

kps:SSHKeyPair:importPrivateKey

Grants permission to import a private key to a key pair.

Write

SSHKeyPair *

kps:KmsKeyId

  • kps:domainKeypairs:importpk

kps:SSHKeyPair:exportPrivateKey

Grants permission to export the private key of a key pair.

Write

SSHKeyPair *

-

  • kps:domainKeypairs:exportpk

kps:SSHKeyPair:clearPrivateKey

Grants permission to clear the private key of a key pair.

Write

SSHKeyPair *

-

  • kps:domainKeypairs:clearpk

Each API of KPS usually supports one or more actions. Table 2 lists the supported actions and dependencies.

Table 2 Actions and dependencies supported by KPS APIs

API

Action

Dependencies

POST /v3/{project_id}/keypairs

kps:SSHKeyPair:create

  • kms:cmk:createDataKey
  • kms:cmk:list

DELETE /v3/{project_id}/keypairs/{keypair_name}

kps:SSHKeyPair:delete

-

GET /v3/{project_id}/keypairs/{keypair_name}

kps:SSHKeyPair:get

-

GET /v3/{project_id}/keypairs

kps:SSHKeyPair:list

-

PUT /v3/{project_id}/keypairs/{keypair_name}

kps:SSHKeyPair:update

-

POST /v3/{project_id}/keypairs/associate

kps:SSHKeyPair:bind

  • ecs:cloudServers:createServers
  • ecs:cloudServers:deleteServers
  • ecs:cloudServers:showServer
  • ecs:cloudServers:attach
  • ecs:cloudServers:listServerBlockDevices
  • ecs:cloudServers:showServerBlockDevice
  • ecs:cloudServers:detachVolume
  • ecs:cloudServers:listServerInterfaces
  • ecs:cloudServers:listServersDetails
  • ecs:cloudServerFlavors:get
  • ecs:cloudServerQuotas:get
  • evs:types:get
  • evs:volumes:use
  • ims:images:get
  • vpc:subnets:list

DELETE /v3/{project_id}/failed-tasks

kps::deleteFailedTask

-

DELETE /v3/{project_id}/failed-tasks/{task_id}

kps::deleteFailedTask

-

POST /v3/{project_id}/keypairs/disassociate

kps:SSHKeyPair:unbind

  • ecs:cloudServers:createServers
  • ecs:cloudServers:deleteServers
  • ecs:cloudServers:showServer
  • ecs:cloudServers:attach
  • ecs:cloudServers:listServerBlockDevices
  • ecs:cloudServers:showServerBlockDevice
  • ecs:cloudServers:detachVolume
  • ecs:cloudServers:listServerInterfaces
  • ecs:cloudServers:listServersDetails
  • ecs:cloudServerFlavors:get
  • ecs:cloudServerQuotas:get
  • evs:types:get
  • evs:volumes:use
  • ims:images:get
  • vpc:subnets:list

GET /v3/{project_id}/failed-tasks

kps::getFailedTask

-

GET /v3/{project_id}/tasks/{task_id}

kps::getTask

-

GET /v3/{project_id}/running-tasks

kps::getRunningTask

-

POST /v3/{project_id}/keypairs/private-key/import

kps:SSHKeyPair:importPrivateKey

  • kms:cmk:createDataKey
  • kms:cmk:list

POST /v3/{project_id}/keypairs/private-key/export

kps:SSHKeyPair:exportPrivateKey

kms:cmk:decryptDataKey

POST /v3/{project_id}/keypairs/batch-associate

kps:SSHKeyPair:bind

  • ecs:cloudServers:createServers
  • ecs:cloudServers:deleteServers
  • ecs:cloudServers:showServer
  • ecs:cloudServers:attach
  • ecs:cloudServers:listServerBlockDevices
  • ecs:cloudServers:showServerBlockDevice
  • ecs:cloudServers:detachVolume
  • ecs:cloudServers:listServerInterfaces
  • ecs:cloudServers:listServersDetails
  • ecs:cloudServerFlavors:get
  • ecs:cloudServerQuotas:get
  • evs:types:get
  • evs:volumes:use
  • ims:images:get
  • vpc:subnets:list

DELETE /v3/{project_id}/keypairs/{keypair_name}/private-key

kps:SSHKeyPair:clearPrivateKey

-

Resources

A resource type indicates the resources that an identity policy applies to. If you specify a resource type for any action in Table 3, the resource URN must be specified in the identity policy statements using that action, and the identity policy applies only to resources of this type. If no resource type is specified, the Resource element is marked with an asterisk (*) and the identity policy applies to all resources. You can also set condition keys in an identity policy to define resource types.

The following table lists the resource types that you can define in identity policy statements for KPS.

Table 3 Resource types supported by KPS

Resource Type

URN

SSHKeyPair

kps:<region>:<account-id>:SSHKeyPair:<keypair-name>

Conditions

Condition Key Overview

A Condition element lets you specify conditions for when an identity policy is in effect. It contains condition keys and operators.

  • The condition key that you specify can be a global condition key or a service-specific condition key.
    • Global condition keys (with the g: prefix) apply to all actions. Cloud services do not need to provide user identity information. Instead, the system automatically obtains such information and authenticates users. For details, see Global Condition Keys.
    • Service-specific condition keys (with the abbreviation of a service name plus a colon as the prefix, for example, kps) apply only to operations of the xx service. For details, see Table 4.
    • The number of values associated with a condition key in the request context of an API call makes the condition key single-valued or multivalued. Single-valued condition keys have at most one value in the request context of an API call. Multivalued condition keys can have multiple values in the request context of an API call. For example, a request can originate from at most one VPC endpoint, so g:SourceVpce is a single-valued condition key. You can tag resources and include multiple tag key-value pairs in a request, so g:TagKeys is a multivalued condition key.
  • A condition operator, condition key, and a condition value together constitute a complete condition statement. An identity policy can be applied only when its request conditions are met. For supported condition operators, see operators.

Service-specific condition keys supported by KPS

The following table lists the condition keys that you can define in identity policies for KPS. You can include these condition keys to specify conditions for when your identity policy is in effect.

Table 4 Service-specific condition keys supported by KPS

Service-specific Condition Key

Type

Single-valued/Multivalued

Description

kps:KmsKeyId

string

Single-valued

Filters access by the KMS key ID.

kps:Algorithm

string

Single-valued

Filters access by SSH key algorithm.