接口描述
根据分页信息和过滤条件查询用户信息。默认按照 createTime 降序查询。
HTTP 请求方法
GET
请求路径
/scim/api/v2/Users?startIndex=10&count=10&filter=userName eq "jane.doe@scim.com"
请求参数
参数名称 | 必选 | 类型 | 描述 |
startIndex | 否 | int | 开始下标 。默认：1 |
count | 否 | int | 每一页查询记录数。默认：10；为 -1时，表示查询所有 |
filter | 否 | string | 查询条件，仅支持用户名、手机号、邮箱、组织机构、更新时间单一条件查询，不支持复杂的逻辑条件查询。操作符仅支持 eq、gt。filter 条件符合 scim 语法 |
说明
filter 查询条件：
用户名查询：filter=userName eq "jane.doe@scim.com"。
邮箱查询：filter=emails eq "eee@example.com"。
手机号查询：filter=phoneNumbers eq "13123456789" 。
更新时间查询：filter=lastModified gt "2011-05-13T04:42:34Z"。
组织机构查询：filter=organization eq "f4020ead-d4b7-4c0a-86c0-8eafd7bb7656"。
用户组查询：filter=group eq "5ad69323-49e8-40c9-9116-5f72904ba91b"。
不支持复合条件查询: userName、emails、phoneNumbers、organization、group 支持 eq 操作，lastModified 支持 gt、lt 操作。
响应状态码
状态码 | 返回值 | 描述 |
200 | ok | 请求成功 |
返回字段
参数名称 | 类型 | 描述 |
schemas | array，string | scim 的 schema，返回字符串数组固定值： urn:ietf:params:scim:api:messages:2.0:ListResponse |
totalResults | int | 总记录数 |
itemsPerPage | int | 每页大小，等于入参的 count |
startIndex | string | 入参的 startIndex |
Resources | array,user | user 数组。首字母 R 大写 |
-schemas | array，string | scim 的 schema，返回字符串数组固定值： urn:ietf:params:scim:schemas:core:2.0:User |
- id | string | 用户 id |
- displayName | string | 显示名 |
- userName | string | 用户名 |
- active | boolean | 用户状态。true：启用；false：禁用 |
- organization | array,string | 用户所属组织机构 id |
- group | array,string | 用户组 id |
- emails | array,object | 用户邮箱 |
- value | string | 邮箱 |
- phoneNumbers | array,object | 用户电话 |
- value | string | 电话，格式：+86-1xxxxxxxxx5 |
- meta | object | scim 的标准，用户的元数据 |
- resourceType | string | 资源类型，固定值 User |
- created | string | 创建时间，格式为：2010-01-23T04:56:22Z |
- lastModified | string | 最后修改时间，格式为：2010-01-23T04:56:22Z |
- version | string | 版本号 |
接口示例
入参示例
http://<host>:<ip>/scim/api/v2/Users?startIndex=10&count=10&filter=meta.lastModified gt "2018-04-19T13:47:13Z"
返回示例
{"schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],"totalResults": 20,"itemsPerPage": 10,"startIndex": 10,"Resources": [{"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"id": "758f9a69-0a48-43ab-9d76-6cce766c5aaa","meta": {"resourceType": "User","created": "2010-01-23T04:56:22Z","version":"0","lastModified": "2010-01-23T04:56:22Z"},"userName": "iamadmin","displayName": "iamadmin","active": true,"emails": [{"value": "1234234@qq.com",}],"phoneNumbers": [{"value": "+86-19981285885",}],"organization": ["02352698-e4f0-4231-92d4-2e6aef309ed0"],"group":["12352698-e4f0-4231-92d4-2e6aef309ed0"]，"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {"test3": "test3-777777777777777777"}}]}
