DescribeSafeAuthFlagColl

Last updated: 2021-06-17 15:04:49

    1. API Description

    Domain name for API request: cam.tencentcloudapi.com.

    This API is used to query security settings.

    A maximum of 20 requests can be initiated per second for this API.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common parameter. The value used for this API: DescribeSafeAuthFlagColl.
    Version Yes String Common parameter. The value used for this API: 2019-01-16.
    Region No String Common parameter. This parameter is not required for this API.
    SubUin Yes Integer Sub-account

    3. Output Parameters

    Parameter Name Type Description
    LoginFlag LoginActionFlag Login protection settings
    ActionFlag LoginActionFlag Sensitive operation protection settings
    OffsiteFlag OffsiteFlag Suspicious login location protection settings
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying security settings

    Input Example

    https://cam.tencentcloudapi.com/?Action=DescribeSafeAuthFlagColl
    &SubUin=1234567
    &<Common request parameters>
    

    Output Example

    {
    "Response": {
      "LoginFlag": {
        "Phone": 1,
        "Token": 0,
        "Stoken": 0,
        "Wechat": 0,
        "Custom": 0
      },
      "ActionFlag": {
        "Phone": 0,
        "Token": 0,
        "Stoken": 0,
        "Wechat": 0,
        "Custom": 0
      },
      "OffsiteFlag": {
        "VerifyFlag": 0,
        "NotifyPhone": 1,
        "NotifyEmail": 1,
        "NotifyWechat": 1,
        "Tips": 0
      },
      "RequestId": "9626da03-4645-4c54-ba90-74836284af0c"
    }
    }
    

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    FailedOperation Operation failed.
    InvalidParameter.ParamError Invalid input parameter.
    ResourceNotFound.UserNotExist User does not exist.