Resolve Home Sites

Resolve Home Sites

All the listed privileges are required -

Privileges Description
FEDERATED_LDAP_VIEW Resolves and returns only those home sites for which caller has permission to this privilege on associated federated access group of GAE/GDE.
Request
URI
POST
https://{api_host}//localhost/rest/federation/v1/home-sites/action/resolve
COPY
Request Body

Home site specification to be resolved.

HomeSiteResolutionSpec of type(s) application/json
Required
{
    "global_application_entitlement_id": "751c7619-bc3b-48cd-80d1-29960375b6d8",
    "global_desktop_entitlement_id": "9e94a90d-e7c2-40b6-a702-bd781512408d",
    "user_id": "S-1-5-21-3623811015-3361044348"
}
string
global_application_entitlement_id
Optional

ID of the Global Application Entitlement this home site resolution is for.

string
global_desktop_entitlement_id
Optional

ID of the Global Desktop Entitlement this home site resolution is for.

string
user_id
Required

SID of the user for whom home site is to be resolved.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

[
    {
        "global_application_entitlement_id": "f309c150-ff8b-4391-ad5d-96e1a3c3cb70",
        "global_desktop_entitlement_id": "dc2c29ce-baae-47b5-90e6-d7ab1d3b82288",
        "resolution_data": [
            {
                "group_id": "S-1-5-32-568",
                "id": "28deeb70-97d5-409e-abb4-497196f1ee18",
                "resolved": true,
                "site_id": "52457bcd-9641-48b1-a1ac-a8c58069ef48",
                "type": "USER_DEFAULT"
            }
        ]
    }
]

400

Bad Request

Operation doesn't return any data structure

401

User is not authenticated

Operation doesn't return any data structure

403

Access to the resource is forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

409

Conflict | CPA not initialized for the pod

Operation doesn't return any data structure