用户登出

POST

/public-api/user/sign-out

接口简介

通过外部用户ID或者账号ID退出账号信息，【外部用户-第三方用户、账户ID-loginId】

请求参数

Body 参数application/json

token

string

应用Token

必需

在观远平台管理员设置-系统集成-统一账户集成中获得

provider

string

登录模式说明

可选

登陆provider。各类登陆的provider由下面的列表提供。如果provider为空，则根据BI系统账号进行退出。

externalUserId

string

外部用户ID或者账号

必需

如果provider不为空，此值为接入方用户账号，也即单点登录时的用户账号；如果provider为空，此值为BI系统账号。

示例

{
    "token": "string",
    "provider": "string",
    "externalUserId": "string"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/public-api/user/sign-out' \
--header 'Content-Type: application/json' \
--data-raw '{
    "token": "string",
    "provider": "string",
    "externalUserId": "string"
}'

返回响应

🟢200成功

application/json

Body

result

string

请求状态

必需

枚举值: ok、fail

response

string

响应结果

必需

示例

{
    "result": "ok",
    "response": "All login sessions for the user have been logged out."
}

修改于 2025-02-28 05:47:35

通过用户的loginId登录

用户管理概述