GET /api/login/domains

Returns information about the login domains that are valid for the platform.

Authorization Roles/Permissions: Anyone can use this operation; login is not required. However, note that for any operations that do not require login, information about private resources is not returned unless the user is logged in and is authorized to view information about those resources. Without login, only public information is returned.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/login/domains

Back to top

Sample Request

The example below shows a request for login domain information.

Request URL

https://{hostname}/api/login/domains?IncludeDisabled=true&all=true&cache=false

Sample request headers

GET /api/login/domains?IncludeDisabled=true&all=true&cache=false HTTP/1.1
Host: {hostname}
Accept: application/json, text/javascript, */*; q=0.01

Sample request body

Not applicable.

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
all Query boolean Optional Indicates whether all login domains should be included in the response. If not specified, defaults to false.
IncludeDisabled Query boolean Optional Indicates whether domains that are currently disabled should be included in the response. If not specified, defaults to false.
cache Query boolean Optional Indicates whether the information should be cached. If you don't want the domain information to be read from cache, specify false. If not specified, defaults to true. For more information about caching on the platform, see How the Platform API Uses Caching.

Back to top

Response

If successful, this operation returns HTTP status code 200, with information about available domains.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

HTTP/1.1 200 OK
Content-Type: application/vnd.soa.v72+json
Date: Wed, 17 Dec 2014 15:00:11 GMT

Sample response body

[ {
  "LoginDomainID" : "siteusers.acmepaymentscorp",
  "FedmemberId" : "acmepaymentscorp",
  "Title" : "acmepaymentscorp-users",
  "Sequence" : -1,
  "VirtualHost" : [ ],
  "IdSystemType" : "Policy Manager",
  "LogoAssigned" : false,
  "Enabled" : true
}, {
  "LoginDomainID" : "303f3747-14f9-4a11-a14f-00aff83bf2d8.acmepaymentscorp",
  "DomainName" : "LdapAutomation",
  "FedmemberId" : "acmepaymentscorp",
  "DisplayMode" : "POPUP",
  "Title" : "LdapAutomation",
  "Sequence" : 1,
  "VirtualHost" : [ ],
  "IdSystemType" : "Directory Server",
  "LogoAssigned" : false,
  "Enabled" : true
}, {
  "LoginDomainID" : "ac2dbf6d-e96c-4625-9e48-39b538d75bd7.acmepaymentscorp",
  "DomainName" : "GoogleAutomation",
  "FedmemberId" : "acmepaymentscorp",
  "DisplayMode" : "POPUP",
  "Title" : "GoogleAutomation",
  "Sequence" : 2,
  "VirtualHost" : [ ],
  "IdSystemType" : "com.soa.securitydomain.openid.relyingparty",
  "LogoAssigned" : false,
  "Enabled" : true
} ]

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json

Back to top

Response Body

Name Type Description
LoginDomain[ ] LoginDomain[ ] Includes information about one or more login domains valid for the current instance of the platform.

Back to top

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics