Skip to content

Commit 2392dd9

Browse files
fern-api[bot]fern-api[bot]
committed
SDK regeneration
1 parent 77d3022 commit 2392dd9

40 files changed

Lines changed: 5285 additions & 1467 deletions

File tree

‎reference.md‎

Lines changed: 390 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24160,6 +24160,396 @@ client.organizations().clientGrants().delete("id", "grant_id");
2416024160
</dl>
2416124161

2416224162

24163+
</dd>
24164+
</dl>
24165+
</details>
24166+
24167+
## Organizations Connections
24168+
<details><summary><code>client.organizations.connections.list(id) -> SyncPagingIterable&amp;lt;OrganizationAllConnectionPost&amp;gt;</code></summary>
24169+
<dl>
24170+
<dd>
24171+
24172+
#### 🔌 Usage
24173+
24174+
<dl>
24175+
<dd>
24176+
24177+
<dl>
24178+
<dd>
24179+
24180+
```java
24181+
client.organizations().connections().list(
24182+
"id",
24183+
ListOrganizationAllConnectionsRequestParameters
24184+
.builder()
24185+
.page(
24186+
OptionalNullable.of(1)
24187+
)
24188+
.perPage(
24189+
OptionalNullable.of(1)
24190+
)
24191+
.includeTotals(
24192+
OptionalNullable.of(true)
24193+
)
24194+
.isEnabled(
24195+
OptionalNullable.of(true)
24196+
)
24197+
.build()
24198+
);
24199+
```
24200+
</dd>
24201+
</dl>
24202+
</dd>
24203+
</dl>
24204+
24205+
#### ⚙️ Parameters
24206+
24207+
<dl>
24208+
<dd>
24209+
24210+
<dl>
24211+
<dd>
24212+
24213+
**id:** `String` — Organization identifier.
24214+
24215+
</dd>
24216+
</dl>
24217+
24218+
<dl>
24219+
<dd>
24220+
24221+
**page:** `Optional<Integer>` — Page index of the results to return. First page is 0.
24222+
24223+
</dd>
24224+
</dl>
24225+
24226+
<dl>
24227+
<dd>
24228+
24229+
**perPage:** `Optional<Integer>` — Number of results per page. Defaults to 50.
24230+
24231+
</dd>
24232+
</dl>
24233+
24234+
<dl>
24235+
<dd>
24236+
24237+
**includeTotals:** `Optional<Boolean>` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).
24238+
24239+
</dd>
24240+
</dl>
24241+
24242+
<dl>
24243+
<dd>
24244+
24245+
**isEnabled:** `Optional<Boolean>` — Filter connections by enabled status.
24246+
24247+
</dd>
24248+
</dl>
24249+
</dd>
24250+
</dl>
24251+
24252+
24253+
</dd>
24254+
</dl>
24255+
</details>
24256+
24257+
<details><summary><code>client.organizations.connections.create(id, request) -> CreateOrganizationAllConnectionResponseContent</code></summary>
24258+
<dl>
24259+
<dd>
24260+
24261+
#### 🔌 Usage
24262+
24263+
<dl>
24264+
<dd>
24265+
24266+
<dl>
24267+
<dd>
24268+
24269+
```java
24270+
client.organizations().connections().create(
24271+
"id",
24272+
CreateOrganizationAllConnectionRequestParameters
24273+
.builder()
24274+
.connectionId("connection_id")
24275+
.build()
24276+
);
24277+
```
24278+
</dd>
24279+
</dl>
24280+
</dd>
24281+
</dl>
24282+
24283+
#### ⚙️ Parameters
24284+
24285+
<dl>
24286+
<dd>
24287+
24288+
<dl>
24289+
<dd>
24290+
24291+
**id:** `String` — Organization identifier.
24292+
24293+
</dd>
24294+
</dl>
24295+
24296+
<dl>
24297+
<dd>
24298+
24299+
**organizationConnectionName:** `Optional<String>` — Name of the connection in the scope of this organization.
24300+
24301+
</dd>
24302+
</dl>
24303+
24304+
<dl>
24305+
<dd>
24306+
24307+
**assignMembershipOnLogin:** `Optional<Boolean>` — 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.
24308+
24309+
</dd>
24310+
</dl>
24311+
24312+
<dl>
24313+
<dd>
24314+
24315+
**showAsButton:** `Optional<Boolean>` — Determines whether a connection should be displayed on this organization’s login prompt. Only applicable for enterprise connections. Default: true.
24316+
24317+
</dd>
24318+
</dl>
24319+
24320+
<dl>
24321+
<dd>
24322+
24323+
**isSignupEnabled:** `Optional<Boolean>` — Determines whether organization signup should be enabled for this organization connection. Only applicable for database connections. Default: false.
24324+
24325+
</dd>
24326+
</dl>
24327+
24328+
<dl>
24329+
<dd>
24330+
24331+
**organizationAccessLevel:** `Optional<OrganizationAccessLevelEnum>`
24332+
24333+
</dd>
24334+
</dl>
24335+
24336+
<dl>
24337+
<dd>
24338+
24339+
**isEnabled:** `Optional<Boolean>` — Whether the connection is enabled for the organization.
24340+
24341+
</dd>
24342+
</dl>
24343+
24344+
<dl>
24345+
<dd>
24346+
24347+
**connectionId:** `String` — Connection identifier.
24348+
24349+
</dd>
24350+
</dl>
24351+
</dd>
24352+
</dl>
24353+
24354+
24355+
</dd>
24356+
</dl>
24357+
</details>
24358+
24359+
<details><summary><code>client.organizations.connections.get(id, connectionId) -> GetOrganizationAllConnectionResponseContent</code></summary>
24360+
<dl>
24361+
<dd>
24362+
24363+
#### 🔌 Usage
24364+
24365+
<dl>
24366+
<dd>
24367+
24368+
<dl>
24369+
<dd>
24370+
24371+
```java
24372+
client.organizations().connections().get("id", "connection_id");
24373+
```
24374+
</dd>
24375+
</dl>
24376+
</dd>
24377+
</dl>
24378+
24379+
#### ⚙️ Parameters
24380+
24381+
<dl>
24382+
<dd>
24383+
24384+
<dl>
24385+
<dd>
24386+
24387+
**id:** `String` — Organization identifier.
24388+
24389+
</dd>
24390+
</dl>
24391+
24392+
<dl>
24393+
<dd>
24394+
24395+
**connectionId:** `String` — Connection identifier.
24396+
24397+
</dd>
24398+
</dl>
24399+
</dd>
24400+
</dl>
24401+
24402+
24403+
</dd>
24404+
</dl>
24405+
</details>
24406+
24407+
<details><summary><code>client.organizations.connections.delete(id, connectionId)</code></summary>
24408+
<dl>
24409+
<dd>
24410+
24411+
#### 🔌 Usage
24412+
24413+
<dl>
24414+
<dd>
24415+
24416+
<dl>
24417+
<dd>
24418+
24419+
```java
24420+
client.organizations().connections().delete("id", "connection_id");
24421+
```
24422+
</dd>
24423+
</dl>
24424+
</dd>
24425+
</dl>
24426+
24427+
#### ⚙️ Parameters
24428+
24429+
<dl>
24430+
<dd>
24431+
24432+
<dl>
24433+
<dd>
24434+
24435+
**id:** `String` — Organization identifier.
24436+
24437+
</dd>
24438+
</dl>
24439+
24440+
<dl>
24441+
<dd>
24442+
24443+
**connectionId:** `String` — Connection identifier.
24444+
24445+
</dd>
24446+
</dl>
24447+
</dd>
24448+
</dl>
24449+
24450+
24451+
</dd>
24452+
</dl>
24453+
</details>
24454+
24455+
<details><summary><code>client.organizations.connections.update(id, connectionId, request) -> UpdateOrganizationAllConnectionResponseContent</code></summary>
24456+
<dl>
24457+
<dd>
24458+
24459+
#### 🔌 Usage
24460+
24461+
<dl>
24462+
<dd>
24463+
24464+
<dl>
24465+
<dd>
24466+
24467+
```java
24468+
client.organizations().connections().update(
24469+
"id",
24470+
"connection_id",
24471+
UpdateOrganizationConnectionRequestParameters
24472+
.builder()
24473+
.build()
24474+
);
24475+
```
24476+
</dd>
24477+
</dl>
24478+
</dd>
24479+
</dl>
24480+
24481+
#### ⚙️ Parameters
24482+
24483+
<dl>
24484+
<dd>
24485+
24486+
<dl>
24487+
<dd>
24488+
24489+
**id:** `String` — Organization identifier.
24490+
24491+
</dd>
24492+
</dl>
24493+
24494+
<dl>
24495+
<dd>
24496+
24497+
**connectionId:** `String` — Connection identifier.
24498+
24499+
</dd>
24500+
</dl>
24501+
24502+
<dl>
24503+
<dd>
24504+
24505+
**organizationConnectionName:** `Optional<String>` — Name of the connection in the scope of this organization.
24506+
24507+
</dd>
24508+
</dl>
24509+
24510+
<dl>
24511+
<dd>
24512+
24513+
**assignMembershipOnLogin:** `Optional<Boolean>` — 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.
24514+
24515+
</dd>
24516+
</dl>
24517+
24518+
<dl>
24519+
<dd>
24520+
24521+
**showAsButton:** `Optional<Boolean>` — Determines whether a connection should be displayed on this organization’s login prompt. Only applicable for enterprise connections. Default: true.
24522+
24523+
</dd>
24524+
</dl>
24525+
24526+
<dl>
24527+
<dd>
24528+
24529+
**isSignupEnabled:** `Optional<Boolean>` — Determines whether organization signup should be enabled for this organization connection. Only applicable for database connections. Default: false.
24530+
24531+
</dd>
24532+
</dl>
24533+
24534+
<dl>
24535+
<dd>
24536+
24537+
**organizationAccessLevel:** `Optional<OrganizationAccessLevelEnumWithNull>`
24538+
24539+
</dd>
24540+
</dl>
24541+
24542+
<dl>
24543+
<dd>
24544+
24545+
**isEnabled:** `Optional<Boolean>` — Whether the connection is enabled for the organization.
24546+
24547+
</dd>
24548+
</dl>
24549+
</dd>
24550+
</dl>
24551+
24552+
2416324553
</dd>
2416424554
</dl>
2416524555
</details>

0 commit comments

Comments
 (0)