Get User Domain¶
Get the domain information of a user using the email address.
Request Format¶
GET http://{apigw-address}/app-portal-service/v2.2/user/domain
Request Parameters (URI)¶
Name |
Location (Path/Query) |
Mandatory/Optional |
Data Type |
Description |
---|---|---|---|---|
Query |
Mandatory |
String |
The email address of the user |
Response Parameters¶
Name |
Data Type |
Description |
---|---|---|
id |
String |
The domain ID |
name |
String |
The domain name |
url |
String |
The domain URL |
description |
String |
The description of the domain |
nameJson |
I18nString |
The organization structure name in Json, supporting multiple languages |
descriptionJson |
I18nString |
The organization structure description in Json, supporting multiple languages |
Error Code¶
Code |
Description |
---|---|
31400 |
Email is required |
31404 |
The email address is not bound to an account |
Samples¶
Request Sample¶
url: http://{apigw-address}/app-portal-service/v2.2/user/domain?email=xxx.yy@envision-digital.com
method: GET
Return Sample¶
{
"code":0,
"data":{
"id":"xxx",
"name":"domain name",
"nameJson": {
"default": "domain name"
},
"url":"domain url",
"description":"domain description"
"descriptionJson": {
"default": "domain description"
},
},
"message":""
}