Added support for Enabled Client Connections (#1114)

Author: tanya732

src/management/__generated/managers/connections-manager.ts

@@ -4,10 +4,12 @@ import type {
   Connection,
   ConnectionCreate,
   ConnectionUpdate,
+  GetConnectionClients200Response,
   GetConnections200Response,
   GetDefaultMapping200Response,
   GetScimConfiguration200Response,
   GetScimTokens200ResponseInner,
+  PatchClientsRequestInner,
   PatchScimConfigurationRequest,
   PostScimConfigurationRequest,
   PostScimToken201Response,
@@ -18,12 +20,14 @@ import type {
   DeleteScimConfigurationRequest,
   DeleteTokensByTokenIdRequest,
   DeleteUsersByEmailRequest,
+  GetConnectionClientsRequest,
   GetConnectionsRequest,
   GetConnectionsByIdRequest,
   GetDefaultMappingRequest,
   GetScimConfigurationRequest,
   GetScimTokensRequest,
   GetStatusRequest,
+  PatchClientsRequest,
   PatchConnectionsByIdRequest,
   PatchScimConfigurationOperationRequest,
   PostScimConfigurationOperationRequest,
@@ -148,6 +152,47 @@ export class ConnectionsManager extends BaseAPI {
     return runtime.VoidApiResponse.fromResponse(response);
   }
 
+  /**
+   * Retrieve all clients that have the specified <a href="https://auth0.com/docs/authenticate/identity-providers">connection</a> enabled.
+   *
+   * <b>Note</b>: The first time you call this endpoint, omit the <code>from</code> parameter. If there are more results, a <code>next</code> value is included in the response. You can use this for subsequent API calls. When <code>next</code> is no longer included in the response, no further results are remaining.
+   *
+   * Get enabled clients for a connection
+   *
+   * @throws {RequiredError}
+   */
+  async getEnabledClients(
+    requestParameters: GetConnectionClientsRequest,
+    initOverrides?: InitOverride
+  ): Promise<ApiResponse<GetConnectionClients200Response>> {
+    runtime.validateRequiredRequestParams(requestParameters, ['id']);
+
+    const queryParameters = runtime.applyQueryParams(requestParameters, [
+      {
+        key: 'take',
+        config: {},
+      },
+      {
+        key: 'from',
+        config: {},
+      },
+    ]);
+
+    const response = await this.request(
+      {
+        path: `/connections/{id}/clients`.replace(
+          '{id}',
+          encodeURIComponent(String(requestParameters.id))
+        ),
+        method: 'GET',
+        query: queryParameters,
+      },
+      initOverrides
+    );
+
+    return runtime.JSONApiResponse.fromResponse(response);
+  }
+
   /**
    * Retrieves detailed list of all <a href="https://auth0.com/docs/authenticate/identity-providers">connections</a> that match the specified strategy. If no strategy is provided, all connections within your tenant are retrieved. This action can accept a list of fields to include or exclude from the resulting list of connections.
    *
@@ -213,6 +258,10 @@ export class ConnectionsManager extends BaseAPI {
           isCollectionFormatMulti: true,
         },
       },
+      {
+        key: 'domain_alias',
+        config: {},
+      },
       {
         key: 'name',
         config: {},
@@ -381,6 +430,38 @@ export class ConnectionsManager extends BaseAPI {
     return runtime.VoidApiResponse.fromResponse(response);
   }
 
+  /**
+   * Update enabled clients for a connection
+   *
+   * @throws {RequiredError}
+   */
+  async updateEnabledClients(
+    requestParameters: PatchClientsRequest,
+    bodyParameters: Array<PatchClientsRequestInner>,
+    initOverrides?: InitOverride
+  ): Promise<ApiResponse<void>> {
+    runtime.validateRequiredRequestParams(requestParameters, ['id']);
+
+    const headerParameters: runtime.HTTPHeaders = {};
+
+    headerParameters['Content-Type'] = 'application/json';
+
+    const response = await this.request(
+      {
+        path: `/connections/{id}/clients`.replace(
+          '{id}',
+          encodeURIComponent(String(requestParameters.id))
+        ),
+        method: 'PATCH',
+        headers: headerParameters,
+        body: bodyParameters,
+      },
+      initOverrides
+    );
+
+    return runtime.VoidApiResponse.fromResponse(response);
+  }
+
   /**
    * Update details for a specific <a href="https://auth0.com/docs/authenticate/identity-providers">connection</a>, including option properties for identity provider configuration.
    *

src/management/__generated/models/index.ts

@@ -3058,7 +3058,7 @@ export interface Connection {
    */
   realms: Array<string>;
   /**
-   * The ids of the clients for which the connection is enabled
+   * DEPRECATED property. Use the GET /connections/:id/clients endpoint to get the ids of the clients for which the connection is enabled
    *
    */
   enabled_clients: Array<string>;
@@ -3101,7 +3101,7 @@ export interface ConnectionCreate {
    */
   options?: ConnectionCreateOptions;
   /**
-   * The identifiers of the clients for which the connection is to be enabled. If the array is empty or the property is not specified, no clients are enabled
+   * DEPRECATED property. Use the PATCH /v2/connections/{id}/clients endpoint to enable the connection for a set of clients.
    *
    */
   enabled_clients?: Array<string>;
@@ -3542,7 +3542,7 @@ export interface ConnectionUpdate {
    */
   options?: ConnectionUpdateOptions | null;
   /**
-   * The identifiers of the clients for which the connection is to be enabled. If the property is not specified, no clients are enabled. If the array is empty, the connection will be disabled for every client.
+   * DEPRECATED property. Use the PATCH /v2/connections/{id}/clients endpoint to enable or disable the connection for any clients.
    *
    */
   enabled_clients?: Array<string>;
@@ -5535,6 +5535,33 @@ export interface GetClients200ResponseOneOf1 {
    */
   clients: Array<Client>;
 }
+/**
+ *
+ */
+export interface GetConnectionClients200Response {
+  [key: string]: any | any;
+  /**
+   * Clients for which the connection is enabled
+   *
+   */
+  clients: Array<GetConnectionClients200ResponseClientsInner>;
+  /**
+   * Encoded next token
+   *
+   */
+  next?: string;
+}
+/**
+ *
+ */
+export interface GetConnectionClients200ResponseClientsInner {
+  [key: string]: any | any;
+  /**
+   * The client id
+   *
+   */
+  client_id: string;
+}
 /**
  *
  */
@@ -9690,6 +9717,21 @@ export const PatchClientGrantsByIdRequestOrganizationUsageEnum = {
 export type PatchClientGrantsByIdRequestOrganizationUsageEnum =
   (typeof PatchClientGrantsByIdRequestOrganizationUsageEnum)[keyof typeof PatchClientGrantsByIdRequestOrganizationUsageEnum];
 
+/**
+ *
+ */
+export interface PatchClientsRequestInner {
+  /**
+   * The client_id of the client to be the subject to change status
+   *
+   */
+  client_id: string;
+  /**
+   * Whether the connection is enabled or not for this client_id
+   *
+   */
+  status: boolean;
+}
 /**
  *
  */
@@ -18277,6 +18319,26 @@ export interface DeleteUsersByEmailRequest {
    */
   email: string;
 }
+/**
+ *
+ */
+export interface GetConnectionClientsRequest {
+  /**
+   * The id of the connection for which enabled clients are to be retrieved
+   *
+   */
+  id: string;
+  /**
+   * Number of results per page. Defaults to 50.
+   *
+   */
+  take?: number;
+  /**
+   * Optional Id from which to start selection.
+   *
+   */
+  from?: string;
+}
 
 /**
  *
@@ -18382,6 +18444,11 @@ export interface GetConnectionsRequest {
    *
    */
   strategy?: Array<GetConnectionsStrategyEnum>;
+  /**
+   * Provide the domain_alias to only retrieve connections with such domain
+   *
+   */
+  domain_alias?: string;
   /**
    * Provide the name of the connection to retrieve
    *
@@ -18458,6 +18525,16 @@ export interface GetStatusRequest {
    */
   id: string;
 }
+/**
+ *
+ */
+export interface PatchClientsRequest {
+  /**
+   * The id of the connection to modify
+   *
+   */
+  id: string;
+}
 /**
  *
  */