A domain must be associated with an identity source, but it is not a child object of an identity source as an identity source can be associated with more than one domain.
| Anchor | ||||
|---|---|---|---|---|
|
Attribute | type | values | default | mandate | comment |
name | string | true | |||
netbiosName | string | fasle | |||
dnsName | string | false | |||
description | string | false | |||
isDefault | Boolean | False | |||
identitySource | object | true | associated identity source | ||
policies | coll | true | Assigned policies | ||
repository | object | ||||
radiusProfile | object | ||||
radiusAttributes | coll | ||||
failThruServers | coll | ||||
messageTemplate | Object |
| Anchor | ||||
|---|---|---|---|---|
|
To create a new domain, we must specify the name of the domain and the associated identity source. On success, the method always returns the internal domain id of the newly created domain.
Parameters:
{
"attrs":{list of attribute value pairs}
}
Response:
{
"error":0,
"result":{"id":the id of the newly created domain}
}
Examples:
Method:/domain/create
Parameters:
{
"attrs":
{
"name":"acme.com",
"description":"ACME"
"identitySource.id":12,
}
}
Response: {"error":0, "result":{"id":1}}
| Anchor | ||||
|---|---|---|---|---|
|
| Wiki Markup |
|---|
+Examples:+
Method:/domain/search
Parameters:
\{
"match":
\[
\[name", "like", "acme%"\]
\],
"return":\["name", "id", "identitySource.id"\],
"sort":"id",
"order":"asc",
"max": 20,
"offset": 10
\}
Response:
\{
"error":0,
"result":
\[
\{
"name":"acme.com",
"id":"2",
"identitySource.name":"1"
\},
\{
...
\}
\]
\} |
| Anchor | ||||
|---|---|---|---|---|
|
| Wiki Markup |
|---|
Method:/domain/get
Parameters:
\{
"match":
\[
\["id", "=", 2\],
\],
"return":\["name", "id", "identitySource.id"\],
\}
Response:
\{
"error":0,
"result":
\{
"name":"acme.com",
"id":"2",
"identitySource.id":"1"
\}
\} |
| Anchor | ||||
|---|---|---|---|---|
|
Method:/domain/set
Parameters:
{
"id":1,
"attrs":{"description":"new description"}
}
Response:
{
"error":0
}
| Anchor | ||||
|---|---|---|---|---|
|
Method:/domain/delete
Parameters:
{
"id":1
}
Response:
{
"error":0
}
| Anchor | ||||
|---|---|---|---|---|
|
Method:/domain/deployTokens
Parameters:
{
"attrs":
{
"domain.id":domain_id,
"product.id":product_id
}
}
Response:
{
"error":0
}
Other Methods:
...