tencent cloud

Feedback

Invalidating Account Login States

Last updated: 2024-07-16 11:25:50

    Feature Description

    This API is used to invalidate the login state (for example, UserSig) of an app account. For example, when a developer finds a malicious account, the developer can call this API to invalidate the user’s login state. When the user uses the original UserSig state to log in to IM, the login fails.
    Note
    After a user’s login state is invalidated using this API, the user can use a newly generated UserSig state to log in to IM. This API can invalidate only one account at a time.

    Call Description

    Example request URL

    https://xxxxxx/v4/im_open_login_svc/kick?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

    Request parameters

    The following table only describes the parameters that are modified when this API is called. For more information on other parameters, see RESTful API Overview.
    Parameter
    Description
    https
    The request protocol is HTTPS, and the request method is POST.
    xxxxxx
    The country/region where your SDKAppID is located.
    China: console.tim.qq.com
    Singapore: adminapisgp.im.qcloud.com
    Seoul: adminapikr.im.qcloud.com
    Frankfurt: adminapiger.im.qcloud.com
    Silicon Valley: adminapiusa.im.qcloud.com
    Jakarta: adminapiidn.im.qcloud.com
    v4/im_open_login_svc/kick
    The request API.
    sdkappid
    The SDKAppID assigned by the IM console when an app is created.
    identifier
    The value of this parameter must be an app admin account. For more information, see App Admin.
    usersig
    The signature generated by the app admin account. For details on the operation, see Generating UserSig.
    random
    A random 32-bit unsigned integer ranging from 0 to 4294967295.
    contenttype
    Request format. The value is always json.

    Maximum call frequency

    200 times/second

    Example request packet

    {
    "UserID":"test"
    }

    Request packet fields

    Field
    Type
    Attribute
    Description
    UserID
    String
    Required
    Username

    Example response packet

    {
    "ActionStatus":"OK",
    "ErrorInfo":"",
    "ErrorCode":0
    }

    Response packet fields

    Field
    Type
    Description
    ActionStatus
    String
    The request processing result. OK: succeeded. FAIL: failed.
    ErrorCode
    Integer
    The error code. 0: succeeded. Other values: failed.
    ErrorInfo
    String
    Error information.

    Error Codes

    Unless a network error (such as error 502) occurs, the HTTP return code for this API is always 200. ErrorCode and ErrorInfo in the response packet represent the actual error code and error information. For public error codes (60000 to 79999), see Error Codes. The following table describes the error codes specific to this API.
    Error Code
    Description
    70107
    The requested user account does not exist.
    70169
    An internal server timeout has occurred. Please try again later.
    70402
    The parameters are invalid. Check whether required fields are specified and specified fields meet protocol requirements.
    70403
    The request requires app admin permissions.
    70500
    An internal server error has occurred. Please try again later.

    Debugging Tool

    Use the RESTful API online debugging tool to debug this API.

    References

    Importing multiple accounts (v4/im_open_login_svc/multiaccount_import)
    Querying the online status of an account (v4/openim/query_online_status)
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support