GET /api/login/domains
Returns information about the login domains that are valid for the platform.
Authorization Roles/Permissions: No permissions required. Anyone can run this operation.
This topic includes the following sections:
HTTP Method
GET
URL
https://{hostname}/api/login/domains
Sample Request
The example below shows a request for login domain information.
Sample 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.
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 |
Cookie | AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies. |
X-Csrf-Token_{fedmemberID} | The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login. |
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. |
Response
If successful, this operation returns HTTP status code 200, with information about available domains.
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" : "Ldapacmepaymentscorp", "FedmemberId" : "acmepaymentscorp", "DisplayMode" : "POPUP", "Title" : "Ldapacmepaymentscorp", "Sequence" : 1, "VirtualHost" : [ ], "IdSystemType" : "Directory Server", "LogoAssigned" : false, "Enabled" : true }, { "LoginDomainID" : "ac2dbf6d-e96c-4625-9e48-39b538d75bd7.acmepaymentscorp", "DomainName" : "Googleacmepaymentscorp", "FedmemberId" : "acmepaymentscorp", "DisplayMode" : "POPUP", "Title" : "Googleacmepaymentscorp", "Sequence" : 2, "VirtualHost" : [ ], "IdSystemType" : "com.soa.securitydomain.openid.relyingparty", "LogoAssigned" : false, "Enabled" : true } ]
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 |
Response Body
Name | Type | Description |
---|---|---|
LoginDomain[ ] | LoginDomain[ ] | Includes information about one or more login domains valid for the current instance of the platform. |
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.