Index |
Get Domain information
This call does not require an auth token. It returns attributes that are pertinent to domain settings
for cases when the user is not authenticated. For example, URL to direct the user to upon logging out or
when auth token is expired.
If the domain doesn't exist, this call returns an empty body:
Authorization token required | false |
Admin Authorization token required | false - Only returns attributes that are pertinent to domain settings for cases when the user is not authenticated |
<GetDomainInfoRequest [applyConfig="{apply-config} (0|1)"]> ## GetDomainInfoRequest
<domain [by="{domain-selector-by} (id|name|virtualHostname|krb5Realm|foreignName)"]>{key}</domain> ## DomainSelector
</GetDomainInfoRequest>
The following table describes elements and attributes you can define within a
<GetDomainInfoRequest>
element:
XPath | Required / Optional | Description |
@applyConfig | Optional (0 or 1) | Type:0|1 If {apply-config} is 1 (true), then certain unset attrs on a domain will get their values from the global config. if {apply-config} is 0 (false), then only attributes directly set on the domain will be returned |
/domain | Optional (0 or 1) | Type:{key} Domain Description for element text content:The key used to identify the domain. Meaning determined by {domain-selector-by} |
/domain@by | Optional (0 or 1) | Type:id|name|virtualHostname|krb5Realm|foreignName Select the meaning of {domain-selector-key} |
<GetDomainInfoResponse> ## GetDomainInfoResponse
<domain name="{name}" id="{id}"> ## DomainInfo
(<a n="{key}" /> ## Attr)*
</domain>
</GetDomainInfoResponse>
The following table describes elements and attributes you can define within a
<GetDomainInfoResponse>
element:
XPath | Required / Optional | Description |
/domain | Optional (0 or 1) | Information about domain |
/domain@name | Required (only 1) | Type:String Name |
/domain@id | Required (only 1) | Type:String ID |
/domain/a | Optional (0 or more) | Attributes |
/domain/a@n | Required (only 1) | Type:String Key |