> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # ListEnabledConnectionsClientData # Package: headless # Namespace: ConnectionsService # Method link: https://dev.wix.com/docs/api-reference/business-management/headless/connections/list-enabled-connections-client-data.md ## Permission Scopes: SCOPE.IDENTITY.MANAGE-SSO-SITE: SCOPE.IDENTITY.MANAGE-SSO-SITE ## Introduction Lists enabled connections with client-safe data only. Returns only enabled connections with a filtered data structure suitable for client-side consumption, excluding sensitive server-side configuration details. The response includes the site's built-in connections, in addition to any connections you create. --- ## REST API ### Schema ``` Method: listEnabledConnectionsClientData Description: Lists enabled connections with client-safe data only. Returns only enabled connections with a filtered data structure suitable for client-side consumption, excluding sensitive server-side configuration details. The response includes the site's built-in connections, in addition to any connections you create. URL: https://www.wixapis.com/iam/connection/v1/connections/enabled/client Method: GET Method parameters: param name: paging | type: CursorPaging - name: limit | type: integer | description: Maximum number of items to return in the results. | validation: minimum 0, maximum 100, format int32 - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. | validation: maxLength 16000 Return type: ListEnabledConnectionsClientDataResponse - name: connections | type: array | description: List of enabled connections with client-safe data only. - name: id | type: string | description: GUID of the connection. Pass this GUID to the login or registration flow to authenticate with this connection. | validation: format GUID - name: appDefId | type: string | description: GUID of the Wix app that defines this connection. Each connection is backed by an app; this field identifies which one. | validation: format GUID - name: displayName | type: string | description: Display name for the connection, shown to users as a sign-in option. | validation: maxLength 32 - name: pagingMetadata | type: CursorPagingMetadata | description: Pagination metadata for cursor-based paging. - name: count | type: integer | description: Number of items returned in current page. | validation: format int32 - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. | validation: maxLength 16000 - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. | validation: maxLength 16000 - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page. + `true`: Another page of results can be retrieved. + `false`: This is the last page. ``` ### Examples ### List enabled connections for client use Retrieves client-safe data for the connections currently enabled on the site. The response excludes server-side configuration, so it is safe to call from a frontend. ```curl curl -X GET \ 'https://www.wixapis.com/iam/connection/v1/connections/enabled/client' \ -H 'Authorization: ' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.identity.connection.listEnabledConnectionsClientData(options) Description: Lists enabled connections with client-safe data only. Returns only enabled connections with a filtered data structure suitable for client-side consumption, excluding sensitive server-side configuration details. The response includes the site's built-in connections, in addition to any connections you create. Method parameters: param name: options | type: ListEnabledConnectionsClientDataOptions none - name: paging | type: CursorPaging | description: Cursor paging options. - name: limit | type: integer | description: Maximum number of items to return in the results. | validation: minimum 0, maximum 100, format int32 - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. | validation: maxLength 16000 Return type: PROMISE - name: connections | type: array | description: List of enabled connections with client-safe data only. - name: _id | type: string | description: GUID of the connection. Pass this GUID to the login or registration flow to authenticate with this connection. | validation: format GUID - name: appDefId | type: string | description: GUID of the Wix app that defines this connection. Each connection is backed by an app; this field identifies which one. | validation: format GUID - name: displayName | type: string | description: Display name for the connection, shown to users as a sign-in option. | validation: maxLength 32 - name: pagingMetadata | type: CursorPagingMetadata | description: Pagination metadata for cursor-based paging. - name: count | type: integer | description: Number of items returned in current page. | validation: format int32 - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. | validation: maxLength 16000 - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. | validation: maxLength 16000 - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page. + `true`: Another page of results can be retrieved. + `false`: This is the last page. ``` ### Examples ### List enabled connections for client use Retrieves client-safe data for the connections currently enabled on the site. ```javascript import { connection } from "@wix/identity"; async function listEnabledConnectionsClientData() { const response = await connection.listEnabledConnectionsClientData(); } /* Promise resolves to: * { * "connections": [ * { * "id": "2f3c8a1e-0b7d-4e2a-9c11-8a1e0b7d4e2a", * "appDefId": "3b93a0c1-5e2d-47e8-9f1a-6c2d8e4b7a91", * "displayName": "Continue with Google" * } * ] * } */ ``` ### listEnabledConnectionsClientData (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { connection } from '@wix/identity'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { connection }, // Include the auth strategy and host as relevant }); async function listEnabledConnectionsClientData(options) { const response = await myWixClient.connection.listEnabledConnectionsClientData(options); }; ``` ---