List SSO Users¶
获取指定组织的 SSO 用户列表信息。
操作权限¶
应用被授权组织的 administrator 策略。
请求格式¶
GET https://{apigw-address}/enos-iam-service/v2.3/user/sso/list
请求参数(URI)¶
名称 | 位置(Path/Query) | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|---|
orgId | Query | 必需 | String | SSO 用户所属的组织 ID。如何获取 orgId 信息>> |
userName | Query | 可选 | String | SSO 用户的用户名。 |
Query | 可选 | String | SSO 用户的邮箱。 | |
phone | Query | 可选 | String | SSO 用户的手机号码。 |
响应参数¶
名称 | 数据类型 | 描述 |
---|---|---|
users | SSO User 结构体数组 | SSO 用户列表,参见 SSO User 结构体。 |
SSO User 结构体 ¶
名称 | 数据类型 | 描述 |
---|---|---|
id | String | SSO 用户 ID。 |
name | String | SSO 用户的用户名。 |
type | Integer |
|
String | SSO 用户的邮箱。 | |
emailVerified | Boolean | 邮箱是否绑定。 |
emailVerifiedAt | String | 邮箱绑定时间。 |
phoneArea | String | SSO 用户的手机号码的国码。 |
phone | String | SSO 用户的手机号码。 |
phoneVerified | Boolean | 手机号码是否绑定。 |
phoneVerifiedAt | String | 手机号码绑定时间。 |
organizationId | String | SSO 用户所属组织。 |
state | Integer | 账号状态。
|
domain | String | 配置的 SSO 身份供应商名称。 |
authType | Integer | 用户类型,SSO 用户类型固定为 2。 |
createTime | String | SSO 用户的创建时间。 |
createdByUserId | String | 创建者 ID。 |
resourceId | String | SSO 用户在 IAM 中的资源 ID。 |
description | String | SSO 用户的描述。 |
passwordState | Integer | 密码状态,一般为 0。(不用的字段) |
passwordExpireTime | Long | 密码过期时间,SSO 用户此值固定为 0。 |
extra | Map | 一般为空(不用的字段) |
示例¶
请求示例¶
url: https://{apigw-address}/enos-iam-service/v2.3/user/sso/list?orgId=yourOrgId
method: GET
返回示例¶
{
"fail": false,
"success": true,
"failed": false,
"message": "",
"users": [
{
"id": "userId",
"name": "john",
"type": 1,
"email": "john@doe.com",
"extra": {},
"phone": "",
"state": 0,
"domain": "ssodemo",
"authType": 2,
"phoneArea": "86",
"createTime": "2021-10-20 10:36:04.0",
"resourceId": "rsrcId4695382",
"description": "SSO USER",
"emailVerified": true,
"passwordState": 0,
"phoneVerified": false,
"organizationId": "orgId",
"createdByUserId": "0",
"emailVerifiedAt": "2021-10-20 10:36:04.0",
"phoneVerifiedAt": "1970-01-01 00:00:00.0",
"passwordExpireTime": 0
},
{
"id": "userId2",
"name": "jane",
"type": 1,
"email": "jane@doe.com",
"extra": {},
"phone": "1888888888",
"state": 0,
"domain": "ssodemo",
"authType": 2,
"phoneArea": "86",
"createTime": "2021-10-20 10:29:45.0",
"resourceId": "rsrcId9865829",
"description": "SSO USER",
"emailVerified": true,
"passwordState": 0,
"phoneVerified": false,
"organizationId": "orgId",
"createdByUserId": "0",
"emailVerifiedAt": "2021-10-20 10:29:45.0",
"phoneVerifiedAt": "1970-01-01 00:00:00.0",
"passwordExpireTime": 0
}
],
"status": 0,
"successful": true
}