组织管理 - XAuth开发指南-身份云引擎云开创者-XAuth开发帮助

接口调用说明
创建组织
查看组织列表
查看组织根节点信息
查看组织详情
更新组织名称
删除组织

接口调用说明

此页面上的所有端点都以BaseUrl为首拼接，您的baseUrl如下所示：

https://${yourXAuthDomain}

SSWS Token：

请求以下的API需要包含api_token, 通过管理员登录XAuth的控制台，【API】-【Token】-【创建token】来创建调用管理API的Token

创建组织

POST ${baseUrl}/api/v1/account/org?orgName=Noname&originId=

创建XAuth本地组织

请求示例

curl -X 'POST' \
  'https://${yourXAuthDomain}/api/v1/account/org?orgName=Noname&originId=' \
  -H 'accept: application/json' \
  -H 'Authorization: SSWS ${api_token}' \

参数	描述	是否必填	类型
orgName	组织名称	是	String
originId	组织ID	否	String

响应示例

{
    "orgId": "T7mTQvbW",
    "success": true
}

查看组织列表

GET ${baseUrl}/api/v1/account/org?page=integer&limit=integer

查看当前租户下所有的组织

请求示例

curl -X 'GET' \
  'https://${yourXAuthDomain}/api/v1/account/org?page=1&limit=10' \
  -H 'accept: application/json' \
  -H 'Authorization: SSWS ${api_token}' \

参数	描述	是否必填	类型
page	页码	否	Integer
limit	每页数量	否	Integer

响应示例

{
    "count": 3,
    "organizations": [
        {
            "orgId": "NDL3CD3p",
            "name": "测试组织",
            "originId": ""
        },
        {
            "orgId": "YkeTkv2Y",
            "name": "sftest",
            "originId": ""
        },
        {
            "orgId": "HXmQDQtJ",
            "name": "sfkj",
            "originId": ""
        }
    ]
}

参数	描述	类型
orgId	组织ID	String
name	组织名称	String
originId	兼容外部系统的部门id，方便关联到其它系统的组织部门	String

查看组织根节点信息

GET ${baseUrl}/api/v1/account/org/:orgId

查看组织根节点信息

请求示例

curl -X 'GET' \
  'https://${yourXAuthDomain}/api/v1/account/org/:orgId' \
  -H 'accept: application/json' \
  -H 'Authorization: SSWS ${api_token}' \
  -d 'orgId:string'

参数	描述	是否必填	类型
orgId	组织ID	是	String

响应示例

{
    "orgId": "NDL3CD3p",
    "name": "测试组织",
    "originId": "",
    "type": "local",
    "memberCount": 43,
    "editable": true
}

查看组织详情

GET ${baseUrl}/api/v1/account/org/{OrgId}

获取指定组织的信息

请求示例

curl -X 'GET' \
  'http://${yourXAuthDomain}/api/v1/account/org/WAoUgfsM' \
  -H 'accept: application/json' \
  -H 'Authorization: SSWS ${api_token}'

响应示例

{
  "orgId": "WAoUgfsM",
  "name": "AB集团",
  "originId": "AB集团",
  "type": "local",
  "memberCount": 1452,
  "editable": true
}

参数	描述	类型
orgId	组织的唯一标识	String
name	组织的名字	String
originId	外部Id	Sting
type	本地 or 其他身份源	String
memberCount	用户成员的数量	String
editable	是否可以编辑	Bool

更新组织名称

PUT ${baseUrl}/api/v1/account/org/:orgId?name=Noname

更新组织名称。只可以修改本地创建的组织

请求示例

curl -X 'PUT' \
  'https://${yourXAuthDomain}/api/v1/account/org/:orgId?name=Noname' \
  -H 'Content-Type:application/json'\
  -H 'accept: application/json' \
  -H 'Authorization: SSWS ${api_token}'\
  -d 'orgId:string'

参数	描述	是否必填	类型
orgId	组织ID	是	String
groupName	组织名称	否	String

响应示例

null

删除组织

DELETE ${baseUrl}/api/v1/account/org/:orgId

删除组织。可成功删除的逻辑：1.本地组织 2.非本地组织且关联的源IdP已经被删除

请求示例

curl -X 'POST' \
  'https://${yourXAuthDomain}/api/v1/account/org/:orgId' \
  -H 'accept: application/json' \
  -H 'Authorization: SSWS ${api_token}' \
  -d 'orgId:string'

参数	描述	是否必填	类型
orgId	组织ID，该属性必须唯一	是	String

响应示例

null