Disconnect users and applications from Search
The Search API is currently in Early Availability status. For more information, see Product lifecycle phases.
Description: Disconnect a user connection from AppDirect Search. User connections are identified by the user's accountName and associated application UUID.
API reference documentation: Disconnect user connections
Endpoint URL: {base marketplace URL}/api/appwise/v2/accounts
The {base marketplace URL}
is the base URL for the marketplace that
hosts the user account.
Request operation: DELETE
Prerequisites:
If you do not have the values for required parameters, such as the accountName, use the following endpoints to retrieve or construct them. Other endpoints might also return the required values.
AccountName: The accountName parameter is constructed as follows:
{user_handle}@{user_uuid}@{company_uuid}
. If you do not have the user's
accountName, use one of the following sources:
-
If the response from the Create user connection request is available, refer to it.
-
If the response from the Create user connection request is not available, use the endpoints that appear in the following table to retrieve the values that you need to construct the accountName:
Endpoint sources for required request parameter values:
Required request parameter | Endpoint for retrieval | Response property that contains the value |
---|---|---|
[applicationToConnect object] id—also known as {application_uuid} and {product_uuid} | List all products | uuid |
[userToConnect object] handle | n/a—assigned and provided by the vendor | |
[userToConnect object] userid—the user's UUID | List all users | uuid |
[userToConnect object] companyid—the company's UUID | Read user memberships | CompanyAccountV2.uuid |
Mandatory parameters:
-
accountName—The user's Search connection identifier
({user_handle}@{user_uuid}@{company_uuid})
-
appId—The product UUID
JSON examples:
For request and response JSON examples, see Disconnect user accounts in the reference documentation.
Was this page helpful?
Tell us more…
Help us improve our content. Responses are anonymous.
Thanks
We appreciate your feedback!