All Products
Search
Document Center

Smart Access Gateway:KickOutClients

Last Updated:Mar 03, 2024

Closes a connection based on the Smart Access Gateway (SAG) app instance ID and username.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
smartag:KickOutClientsWrite
  • SmartAccessGateway
    acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region where the SAG APP instance is deployed.

cn-shanghai
SmartAGIdstringYes

The ID of the SAG APP instance.

sag-ehjfb*******
UsernamestringYes

The username of the client account. Usernames of client accounts added to the same SAG APP instance are unique.

For a client account, if you specify the username, you must also specify the password.

doctest

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

76FD7E08-6AA1-4B1B-99FB-8B3CA6C99A8E

Examples

Sample success responses

JSONformat

{
  "RequestId": "76FD7E08-6AA1-4B1B-99FB-8B3CA6C99A8E"
}

Error codes

HTTP status codeError codeError messageDescription
400ClientUser.NameEmptyYou must specify UserName.You must enter a username.
400SAG.InstanceNoFoundThe specified SAG instance does not exist.The specified SAG instance does not exist.

For a list of error codes, visit the Service error codes.