Skip to content

Feat: Added Organization Connections and type updates #1315

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
developerkunal merged 1 commit into from
Apr 9, 2026
Merged

Feat: Added Organization Connections and type updates #1315

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
314 changes: 314 additions & 0 deletions reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22030,6 +22030,320 @@ await client.organizations.clientGrants.delete("id", "grant_id");
</dl>
</details>

## Organizations Connections

<details><summary><code>client.organizations.connections.<a href="/src/management/api/resources/organizations/resources/connections/client/Client.ts">list</a>(id, { ...params }) -> core.Page&lt;Management.OrganizationAllConnectionPost, Management.ListOrganizationAllConnectionsOffsetPaginatedResponseContent&gt;</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
const pageableResponse = await client.organizations.connections.list("id", {
page: 1,
per_page: 1,
include_totals: true,
is_enabled: true,
});
for await (const item of pageableResponse) {
console.log(item);
}

// Or you can manually iterate page-by-page
let page = await client.organizations.connections.list("id", {
page: 1,
per_page: 1,
include_totals: true,
is_enabled: true,
});
while (page.hasNextPage()) {
page = page.getNextPage();
}

// You can also access the underlying response
const response = page.response;
```

</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — Organization identifier.

</dd>
</dl>

<dl>
<dd>

**request:** `Management.ListOrganizationAllConnectionsRequestParameters`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `ConnectionsClient.RequestOptions`

</dd>
</dl>
</dd>
</dl>

</dd>
</dl>
</details>

<details><summary><code>client.organizations.connections.<a href="/src/management/api/resources/organizations/resources/connections/client/Client.ts">create</a>(id, { ...params }) -> Management.CreateOrganizationAllConnectionResponseContent</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.organizations.connections.create("id", {
connection_id: "connection_id",
});
```

</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — Organization identifier.

</dd>
</dl>

<dl>
<dd>

**request:** `Management.CreateOrganizationAllConnectionRequestParameters`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `ConnectionsClient.RequestOptions`

</dd>
</dl>
</dd>
</dl>

</dd>
</dl>
</details>

<details><summary><code>client.organizations.connections.<a href="/src/management/api/resources/organizations/resources/connections/client/Client.ts">get</a>(id, connection_id) -> Management.GetOrganizationAllConnectionResponseContent</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.organizations.connections.get("id", "connection_id");
```

</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — Organization identifier.

</dd>
</dl>

<dl>
<dd>

**connection_id:** `string` — Connection identifier.

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `ConnectionsClient.RequestOptions`

</dd>
</dl>
</dd>
</dl>

</dd>
</dl>
</details>

<details><summary><code>client.organizations.connections.<a href="/src/management/api/resources/organizations/resources/connections/client/Client.ts">delete</a>(id, connection_id) -> void</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.organizations.connections.delete("id", "connection_id");
```

</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — Organization identifier.

</dd>
</dl>

<dl>
<dd>

**connection_id:** `string` — Connection identifier.

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `ConnectionsClient.RequestOptions`

</dd>
</dl>
</dd>
</dl>

</dd>
</dl>
</details>

<details><summary><code>client.organizations.connections.<a href="/src/management/api/resources/organizations/resources/connections/client/Client.ts">update</a>(id, connection_id, { ...params }) -> Management.UpdateOrganizationAllConnectionResponseContent</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.organizations.connections.update("id", "connection_id");
```

</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — Organization identifier.

</dd>
</dl>

<dl>
<dd>

**connection_id:** `string` — Connection identifier.

</dd>
</dl>

<dl>
<dd>

**request:** `Management.UpdateOrganizationConnectionRequestParameters`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `ConnectionsClient.RequestOptions`

</dd>
</dl>
</dd>
</dl>

</dd>
</dl>
</details>

## Organizations DiscoveryDomains

<details><summary><code>client.organizations.discoveryDomains.<a href="/src/management/api/resources/organizations/resources/discoveryDomains/client/Client.ts">list</a>(id, { ...params }) -> core.Page&lt;Management.OrganizationDiscoveryDomain, Management.ListOrganizationDiscoveryDomainsResponseContent&gt;</code></summary>
Expand Down
60 changes: 60 additions & 0 deletions src/management/api/requests/requests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3070,6 +3070,66 @@ export interface AssociateOrganizationClientGrantRequestContent {
grant_id: string;
}

/**
* @example
* {
* page: 1,
* per_page: 1,
* include_totals: true,
* is_enabled: true
* }
*/
export interface ListOrganizationAllConnectionsRequestParameters {
/** Page index of the results to return. First page is 0. */
page?: number | null;
/** Number of results per page. Defaults to 50. */
per_page?: number | null;
/** Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). */
include_totals?: boolean | null;
/** Filter connections by enabled status. */
is_enabled?: boolean | null;
}

/**
* @example
* {
* connection_id: "connection_id"
* }
*/
export interface CreateOrganizationAllConnectionRequestParameters {
/** Name of the connection in the scope of this organization. */
organization_connection_name?: string;
/** When true, all users that log in with this connection will be automatically granted membership in the organization. When false, users must be granted membership in the organization before logging in with this connection. */
assign_membership_on_login?: boolean;
/** Determines whether a connection should be displayed on this organization’s login prompt. Only applicable for enterprise connections. Default: true. */
show_as_button?: boolean;
/** Determines whether organization signup should be enabled for this organization connection. Only applicable for database connections. Default: false. */
is_signup_enabled?: boolean;
organization_access_level?: Management.OrganizationAccessLevelEnum;
/** Whether the connection is enabled for the organization. */
is_enabled?: boolean;
/** Connection identifier. */
connection_id: string;
}

/**
* @example
* {}
*/
export interface UpdateOrganizationConnectionRequestParameters {
/** Name of the connection in the scope of this organization. */
organization_connection_name?: string | null;
/** When true, all users that log in with this connection will be automatically granted membership in the organization. When false, users must be granted membership in the organization before logging in with this connection. */
assign_membership_on_login?: boolean;
/** Determines whether a connection should be displayed on this organization’s login prompt. Only applicable for enterprise connections. Default: true. */
show_as_button?: boolean;
/** Determines whether organization signup should be enabled for this organization connection. Only applicable for database connections. Default: false. */
is_signup_enabled?: boolean;
organization_access_level?: Management.OrganizationAccessLevelEnumWithNull | null;
/** Whether the connection is enabled for the organization. */
is_enabled?: boolean | null;
}

/**
* @example
* {
Expand Down
Loading
Loading