API安全规则及规范

请参照GitLab SSO Wiki - 国双单点登录系统api安全规则及规范

无特殊说明，API数据传输均使用JSON格式，身份验证均通过签名算法实现。

错误代码及信息

errorCode	message	common reason
0	Success	/
1	Authenticate with kicked off	认证成功,但有旧的成功认证被踢掉
2	Ticket has been kicked off	提供的凭据无效且过期方式为认证时被踢掉（这里指传统的Ticket验证）
1000	Warning	请求被正常处理，有警告
2000	Error	请求被正常处理，有错误
3000	Invalid ip to operation	请求操作的源IP被禁用
4001	Username or password is wrong	用户名密码错误，通常在登录时出现
4002	Invalid Sign	签名无效
4003	Insufficient permissions	权限不足
4004	UNKNOWN	出现未知处理或请求
4006	Data wrong	数据错误，解密数据时解密失败、出现异常等会返回此错误
4008	Time out	请求超时无效，通常出现在验证签名时时间超时
4012	Ticket invalid	提供的凭据无效（这里指传统的Ticket验证）
4022	Gridsum SSO internal error	内部错误
5000	Params wrong	参数错误或无效
5004	Try to connection Gridsum-SSO failed	无法连接到SSO认证服务器

通用错误信息

• 签名无效

{
  "errorCode": 4002,
  "data": null,
  "message": "Invalid Sign"
}

• 权限不足

{
  "errorCode": 4003,
  "data": null,
  "message": "Insufficient permissions"
}

• 数据错误，无法解密

{
  "errorCode": 4006,
  "data": null,
  "message": "Data wrong"
}

• 请求超时无效

{
  "errorCode": 4008,
  "data": null,
  "message": "Time out"
}