Get Organization¶
获取组织信息。
操作权限¶
需授权的资源 |
所需操作权限 |
---|---|
orgId |
Full Access |
有关各资源及其对应的权限,参考 策略,角色,与权限>>。
请求格式¶
POST https://{apigw-address}/enos-iam-service/v2.0/organization/info
请求参数(Header)¶
名称 |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|
Authorization |
必需 |
String |
Session ID,以Bearer Token表示,需要通过调用 Log In 接口后获取。 |
Content-Type |
可选 |
String |
仅支持值 “application/json” |
请求参数(Body)¶
名称 |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|
id |
必需 |
String |
组织ID。如何获取orgId信息>> |
响应参数¶
名称 |
数据类型 |
描述 |
---|---|---|
organization |
List<JSONObject> |
组织信息。详见 Organization结构体>> |
Organization结构体 ¶
名称 |
数据类型 |
描述 |
---|---|---|
id |
String |
组织ID。 |
domain |
String |
大数据平台账号。 |
name |
String |
组织名称。 |
description |
String |
组织描述。 |
code |
String |
组织标识符,如营业执照号码。 |
extra |
List<JSONObejct> |
有关组织的其它信息。 |
type |
Integer Enum |
该组织类型。未定义:-1,个人:1,企业:2。 |
state |
Integer Enum |
该组织的状态。未定义:-1,正常:0,禁用: 1,退出:2. |
approvalState |
Integer Enum |
审批状态。未定义:-1,未批准:0,批准:1,不批准:2。 |
approvalDescription |
String |
审批说明。 |
certificationState |
Integer Enum |
认证状态。未定义的:-1,未认证:0,认证:1。 |
ownerId |
String |
组织所有者的用户 ID。 |
resourceId |
String |
资源的 ID。 |
createTime |
String |
组织的创建时间。 |
createdByUserId |
String |
组织创建者的用户 ID。 |
错误码¶
代码 |
描述 |
---|---|
30401 |
提供的Bearer token无效 |
30404 |
未找到会话信息 |
30404 |
提供的组织ID不存在 |
错误码返回message(供参考)¶
* 30401: Authenticated.
* 30404: User login session expired; Organization does not exist.
示例¶
请求示例¶
url: https://{apigw-address}/enos-iam-service/v2.0/organization/info
method: POST
requestBody: {"id":"yourOrgId"}
headers: {
"Authorization":"yourBearerToken",
"Content-Type":"application/json"
}
返回示例¶
{
"fail": false,
"success": true,
"organization": {
"createdByUserId": "userId",
"resourceId": "resourceId",
"code": "",
"approvalState": 1,
"description": "",
"type": 2,
"ownerId": "userId",
"createTime": "2018-11-20 04:03:06.0",
"domain": "",
"extra": {
"owner": "ownerId",
"property": "2",
"approvedBy": "system",
"scale": "0",
"registerType": "0",
"approvedAt": "2018-11-20 04:03:06",
"version": "2"
},
"name": "Demo",
"id": "orgId",
"state": 0,
"certificationState": 1
},
"failed": false,
"message": "",
"status": 0,
"successful": true
}
Java SDK调用示例¶
public class GetOrganization{
public static String SESSION_ID = "yourBearerToken";
public static final String ORGANIZATIONID = "yourOrgId";
public static void main(String[] args) {
System.out.println("ListOrganization Test");
OrganizationGetRequest organizationGetRequest = new OrganizationGetRequest(SESSION_ID, ORGANIZATIONID);
OrganizationGetResponse response = getPoseidon().getResponse(organizationGetRequest, OrganizationGetResponse.class);
System.out.println("OrganizationGetResponse res; " + JSON.toJSONString(response));
assertNotNull("Response should not be null", response);
}
}