XCan Cloud

English

简体中文

English

简体中文

Appearance

AuthPolicyUser​

Provides a unified entry for querying the relationship between users and authorization policies

Query the authorized policy list of user​

GET
/api/v1/auth/user/{userId}/policy

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

路径参数

userId*

User id

类型integer
必填
格式"int64"

查询参数

dto*
类型object
必填

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

服务器
授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Authorize the policies to user​

POST
/api/v1/auth/user/{userId}/policy

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

路径参数

userId*

User id

类型integer
必填
格式"int64"

请求体​

application/json
JSON
[
0
]

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

服务器
授权
变量
键
值
主体

示例​

cURL
JavaScript
PHP
Python

Delete the authorization policies of user​

DELETE
/api/v1/auth/user/{userId}/policy

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

路径参数

userId*

User id

类型integer
必填
格式"int64"

查询参数

policyIds*

Policy ids

类型array
必填
最大项数200
最小项数0
唯一项true

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

服务器
授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Query the user list of authorization policy​

GET
/api/v1/auth/policy/{policyId}/user

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

路径参数

policyId*

Policy id

类型integer
必填
格式"int64"

查询参数

id
类型integer
格式"int64"
username
类型string
fullName
类型string
mobile
类型string
email
类型string
source
类型string
有效值
"PLATFORM_SIGNUP""INVITATION_CODE_SIGNUP""BACKGROUND_SIGNUP""BACKGROUND_ADDED""THIRD_PARTY_LOGIN""LDAP_SYNCHRONIZE"
enabled
类型boolean
sysAdmin
类型boolean
createdBy
类型integer
格式"int64"
createdDate
类型string
格式"date-time"
pageNo

Page data size, default 1, maximum 100000

类型integer
格式"int32"
最大值100000
最小值1
pageSize

Page data size, default 10, maximum 2000

类型integer
格式"int32"
最大值2000
最小值1
orderBy

Sort field

类型string
orderSort

Sorting method

类型string
有效值
"ASC""DESC"
filters[0].key

Filter field name

类型string
filters[0].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string
有效值
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[0].value

Filter value

filters[1].key

Filter field name

类型string
filters[1].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string
有效值
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[1].value

Filter value

filters[2].key

Filter field name

类型string
filters[2].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string
有效值
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[2].value

Filter value

infoScope

Query information scope

类型string
有效值
"BASIC""DETAIL"

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

服务器
授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Authorize the policy to users​

POST
/api/v1/auth/policy/{policyId}/user

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

路径参数

policyId*

Authorization policy id

类型integer
必填
格式"int64"

请求体​

application/json
JSON
[
0
]

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

服务器
授权
变量
键
值
主体

示例​

cURL
JavaScript
PHP
Python

Delete the associated users of authorization policy​

DELETE
/api/v1/auth/policy/{policyId}/user

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

路径参数

policyId*

Policy id

类型integer
必填
格式"int64"

查询参数

userIds*

User ids

类型array
必填
最大项数200
最小项数0
唯一项true

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

服务器
授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Query the unauthorized policy list of user​

GET
/api/v1/auth/user/{userId}/unauth/policy

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

路径参数

userId*

User id

类型integer
必填
格式"int64"

查询参数

id
类型integer
格式"int64"
name
类型string
code
类型string
type
类型string
有效值
"PRE_DEFINED""USER_DEFINED"
default0
类型boolean
enabled
类型boolean
grantStage
类型string
有效值
"MANUAL""SIGNUP_SUCCESS"
description
类型string
appId
类型integer
格式"int64"
clientId
类型string
createdDate
类型string
格式"date-time"
pageNo

Page data size, default 1, maximum 100000

类型integer
格式"int32"
最大值100000
最小值1
pageSize

Page data size, default 10, maximum 2000

类型integer
格式"int32"
最大值2000
最小值1
orderBy

Sort field

类型string
orderSort

Sorting method

类型string
有效值
"ASC""DESC"
filters[0].key

Filter field name

类型string
filters[0].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string
有效值
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[0].value

Filter value

filters[1].key

Filter field name

类型string
filters[1].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string
有效值
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[1].value

Filter value

filters[2].key

Filter field name

类型string
filters[2].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string
有效值
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[2].value

Filter value

infoScope

Query information scope

类型string
有效值
"BASIC""DETAIL"

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

服务器
授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Query the all associated authorization policies of user​

GET
/api/v1/auth/user/{userId}/policy/associated

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

路径参数

userId*

User id

类型integer
必填
格式"int64"

查询参数

id
类型integer
格式"int64"
name
类型string
code
类型string
type
类型string
有效值
"PRE_DEFINED""USER_DEFINED"
default0
类型boolean
enabled
类型boolean
ignoreAuthOrg
类型boolean
adminFullAssociated
类型boolean
grantStage
类型string
有效值
"MANUAL""SIGNUP_SUCCESS"
description
类型string
appId
类型integer
格式"int64"
clientId
类型string
createdDate
类型string
格式"date-time"
pageNo

Page data size, default 1, maximum 100000

类型integer
格式"int32"
最大值100000
最小值1
pageSize

Page data size, default 10, maximum 2000

类型integer
格式"int32"
最大值2000
最小值1
orderBy

Sort field

类型string
orderSort

Sorting method

类型string
有效值
"ASC""DESC"
filters[0].key

Filter field name

类型string
filters[0].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string
有效值
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[0].value

Filter value

filters[1].key

Filter field name

类型string
filters[1].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string
有效值
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[1].value

Filter value

filters[2].key

Filter field name

类型string
filters[2].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string
有效值
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[2].value

Filter value

infoScope

Query information scope

类型string
有效值
"BASIC""DETAIL"

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

服务器
授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Query the unauthorized user list of policy​

GET
/api/v1/auth/policy/{policyId}/unauth/user

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

路径参数

policyId*

Policy id

类型integer
必填
格式"int64"

查询参数

dto*
类型object
必填

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

服务器
授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Delete the authorization policies of users​

DELETE
/api/v1/auth/user/policy

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

查询参数

userIds*

User ids

类型array
必填
最大项数200
最小项数0
唯一项true
policyIds

Policy ids

类型array
最大项数200
最小项数0
唯一项true

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

服务器
授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Released under the GPL-3.0 License.

Copyright © 2021-2025 XCan Cloud