远焦用户接口

关联数据库文档

详细接口文档

获取远焦用户信息

/user/${username}

该接口可以根据传递的用户名查询远焦系统中的用户信息和账号信息表，返回其对应的用户信息和账号信息。如果不存在对应的用户信息，将会返回错误。请求该接口时，需在请求头中携带 Authorization 以进行鉴权。

Request parameters

Responses

            {
                "error_code": 0,
                "error_message": "success",
                "data": {
                    "user_id": 114514,
                    "username": "example_user",
                    "usertype": "user",
                    "accounts": [
                        {
                            "account_id": 1919810,
                            "integration": "knock",
                            "account": "GTR_1145141919810"
                        }
                    ]
                }
            }
        

            {
                "error_code": 4011,
                "error_message": "invalid authorization token"
            }
        

            {
                "error_code": 4041,
                "error_message": "user not exist"
            }
        

创建远焦接收用户

/user

该接口可以接收一个新的用户信息与其对应的第三方账号集成信息，在对应的数据库中创建记录，如用户已存在/集成不存在等异常情况，将会返回错误。在请求该接口时，需在请求头携带 Authorization 以进行鉴权。用户指的是远焦告警系统中，一个接收通知的逻辑实体(形参)，账号指的是这个逻辑实体所对应的具体通知接收方实现(实参)

Request parameters

                {
                    "username": "example_user",
                    "usertype": "user",
                    "accounts": [
                        {
                            "integration": "lark",
                            "account": "ou_1145141919810"
                        }
                    ]
                }
            

                {
                    "username": "example_user",
                    "usertype": "user"
                }
            

Responses

                {
                    "error_code": 0,
                    "error_message": "success",
                    "data": {
                        "user_id": 114514,
                        "username": "example_user",
                        "usertype": "user",
                        "accounts": [
                            {
                                "account_id": 1919810,
                                "integration": "lark",
                                "account": "ou_1145141919810"
                            }
                        ]
                    }           
                }
        

                {
                    "error_code": 4011,
                    "error_message": "invalid authorization token"
                }
        

                {
                    "error_code": 4041,
                    "error_message": "integration not found"
                }
        

                    {
                        "error_code": 4093,
                        "error_message": "account already exist"
                    }
            

更新远焦用户信息

/user/${username}

该接口可以根据传递的用户名和更新操作列表，对远焦系统中的用户信息和账户信息进行更新，并返回更新后的对应全量信息。如果不存在对应的用户信息，或者更新时出现冲突，将会返回错误。请求该接口时，需在请求头中携带 Authorization 以进行鉴权。

Request parameters

                [
                    {
                        "action": "create",
                        "integration": "lark",
                        "account": "ou_1145141919810"
                    },
                    {
                        "action": "create",
                        "integration": "knock"
                        "account": "GTR_1145141919810"
                    }
                ]
            

                [
                    {
                        "action": "delete",
                        "integration": "slack"
                    }
                    {
                        "action": "update",
                        "integration": "dingtalk",
                        "account": "1145141919810"
                    },
                    {
                        "action": "create",
                        "integration": "youtrack",
                        "account": "1145141919810"
                    }
                ]
            

Responses

            {
                "error_code": 0,
                "error_message": "success",
                "data": {
                    "username": "example_user",
                    "usertype": "user",
                    "accounts": [
                        {
                            "account_id": 1145141919810,
                            "integration": "lark",
                            "account": "ou_1145141919810"
                        }
                    ]
                }
            }
        

            {
                "error_code": 4011,
                "error_message": "invalid authorization token"
            }
        

            {
                "error_code": 4041,
                "error_message": "integration not found"
            }
        

            {
                "error_code": 4093,
                "error_message": "account already exist"
            }
        

Last modified: 28 October 2024