GET /api/users/{UserID}/logindomain
Returns information about the login domain for the specified user.
Authorization Roles/Permissions: Must be logged in. Self (logged in) or Site Admin (for any user).
This topic includes the following sections:
HTTP Method
GET
URL
https://{hostname}/api/users/{UserID}/logindomain
Sample Request
The example below shows a request for the login domain for the specified user.
Sample Request URL
https://{hostname}/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/logindomain
Sample request headers
Accept: application/json
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/xml, application/vnd.soa.v71+json, application/vnd.soa.v71+xml, application/vnd.soa.v72+json, application/vnd.soa.v72+xml, application/vnd.soa.v80+json, application/vnd.soa.v80+xml, application/vnd.soa.v81+json, application/vnd.soa.v81+xml |
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 |
---|---|---|---|---|
UserID | Path | string | Required | The unique ID for a specific user. |
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 the login domain for the user specified in the request message.
Sample Response
The sample response below shows successful completion of this operation.
Sample response headers: application/json
Status Code: 200 OK Content-Type: application/json Expires: Mon, 17 Mar 2014 12:57:33 GMT
Sample response body: application/json
{ "LoginDomainID" : "siteusers.acmepaymentscorp", "FedmemberId" : "acmepaymentscorp", "Title" : "acmepaymentscorp-users", "Sequence" : -1, "IdSystemType" : "Policy Manager", "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/xml, application/vnd.soa.v71+json, application/vnd.soa.v71+xml, application/vnd.soa.v72+json, application/vnd.soa.v72+xml, application/vnd.soa.v80+json, application/vnd.soa.v80+xml, application/vnd.soa.v81+json, application/vnd.soa.v81+xml |
Response Body
Name | Type | Description |
---|---|---|
LoginDomain | LoginDomain | Includes information about a login domain on 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 |
---|---|
401 | Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing. |
500 | An error occurred processing the call. |
More information about Akana API Platform API error messages.