Connect users and applications to Search

Important

The Search API is currently in Early Availability status. For more information, see Product lifecycle phases.

Description: Create a new user connection to share and retrieve data with AppDirect Search. A connection, which usually represents a subscription, associates the following:

• an application (application UUID, also known as product UUID)

• user information (handle, userId, and companyId)

The connection is used to, for example, identify events related to the user's app account.

The response is the user's accountName, which contains the following information in the following format: {user_handle}@{user_uuid}@{company_uuid}

API reference documentation: Create 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: POST

Prerequisites:

When you send the API request, some parameters are required. If you do not have the values for them (for example, the user's UUID), use the endpoints that appear in the following table to retrieve them. Other endpoints might also return the required values.

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

Required parameters:

• [ApplicationToConnect object] id—The application UUID. Also known as the product UUID.
• [UserToConnect object] handle—The user's handle in the application.
• [UserToConnect object] userId—The user's UUID.
• [UserToConnect object] companyId—The UUID for the company to which the user belongs.

Response:

The user's accountName in the following format: {user_handle}@{user_uuid}@{company_uuid}

JSON examples

For request and response JSON examples, see Create user connections in the reference documentation.