Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
107 changes: 105 additions & 2 deletions reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -3965,7 +3965,7 @@ await client.eventStreams.update("id");

```typescript
await client.eventStreams.test("id", {
event_type: "group.created",
event_type: "connection.created",
});
```

Expand Down Expand Up @@ -4042,7 +4042,7 @@ Subscribe to events via Server-Sent Events (SSE)
const response = await client.events.subscribe({
from: "from",
from_timestamp: "from_timestamp",
event_type: ["group.created"],
event_type: ["connection.created"],
});
for await (const item of response) {
console.log(item);
Expand Down Expand Up @@ -25692,6 +25692,109 @@ const response = page.response;
</dl>
</details>

## Organizations Roles Members

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

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List the organization members assigned a specific role within the context of an organization.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
const pageableResponse = await client.organizations.roles.members.list("id", "role_id", {
from: "from",
take: 1,
fields: "fields",
include_fields: true,
});
for await (const item of pageableResponse) {
console.log(item);
}

// Or you can manually iterate page-by-page
let page = await client.organizations.roles.members.list("id", "role_id", {
from: "from",
take: 1,
fields: "fields",
include_fields: 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` — ID of the organization.

</dd>
</dl>

<dl>
<dd>

**role_id:** `string` — ID of the role to retrieve the assigned members for.

</dd>
</dl>

<dl>
<dd>

**request:** `Management.ListOrganizationRoleMembersRequestParameters`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `MembersClient.RequestOptions`

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

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

## Prompts Rendering

<details><summary><code>client.prompts.rendering.<a href="/src/management/api/resources/prompts/resources/rendering/client/Client.ts">list</a>({ ...params }) -> core.Page&lt;Management.ListAculsResponseContentItem, Management.ListAculsOffsetPaginatedResponseContent&gt;</code></summary>
Expand Down
26 changes: 24 additions & 2 deletions src/management/api/requests/requests.ts
Original file line number Diff line number Diff line change
Expand Up @@ -808,7 +808,7 @@ export interface UpdateEventStreamRequestContent {
/**
* @example
* {
* event_type: "group.created"
* event_type: "connection.created"
* }
*/
export interface CreateEventStreamTestEventRequestContent {
Expand All @@ -821,7 +821,7 @@ export interface CreateEventStreamTestEventRequestContent {
* {
* from: "from",
* from_timestamp: "from_timestamp",
* event_type: ["group.created"]
* event_type: ["connection.created"]
* }
*/
export interface SubscribeEventsRequestParameters {
Expand Down Expand Up @@ -1252,6 +1252,7 @@ export interface CreateOrganizationRequestContent {
/** Connections that will be enabled for this organization. See POST enabled_connections endpoint for the object format. (Max of 10 connections allowed) */
enabled_connections?: Management.ConnectionForOrganization[];
token_quota?: Management.CreateTokenQuota;
third_party_client_access?: Management.OrganizationThirdPartyClientAccessEnum;
}

/**
Expand All @@ -1266,6 +1267,7 @@ export interface UpdateOrganizationRequestContent {
branding?: Management.OrganizationBranding;
metadata?: Management.OrganizationMetadata;
token_quota?: Management.UpdateTokenQuota | null;
third_party_client_access?: Management.OrganizationThirdPartyClientAccessEnum;
}

/**
Expand Down Expand Up @@ -3644,6 +3646,26 @@ export interface ListOrganizationMemberRoleSourceGroupsRequestParameters {
role_id: string;
}

/**
* @example
* {
* from: "from",
* take: 1,
* fields: "fields",
* include_fields: true
* }
*/
export interface ListOrganizationRoleMembersRequestParameters {
/** Optional Id from which to start selection. */
from?: string | null;
/** Number of results per page. Defaults to 50. Values above the maximum permitted size are capped. */
take?: number | null;
/** Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields. */
fields?: string | null;
/** Whether specified fields are to be included (true) or excluded (false). Defaults to true. */
include_fields?: boolean | null;
}

/**
* @example
* {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -461,7 +461,7 @@ export class EventStreamsClient {
*
* @example
* await client.eventStreams.test("id", {
* event_type: "group.created"
* event_type: "connection.created"
* })
*/
public test(
Expand Down
6 changes: 6 additions & 0 deletions src/management/api/resources/organizations/client/Client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import { EnabledConnectionsClient } from "../resources/enabledConnections/client
import { GroupsClient } from "../resources/groups/client/Client.js";
import { InvitationsClient } from "../resources/invitations/client/Client.js";
import { MembersClient } from "../resources/members/client/Client.js";
import { RolesClient } from "../resources/roles/client/Client.js";

export declare namespace OrganizationsClient {
export type Options = BaseClientOptions;
Expand All @@ -31,6 +32,7 @@ export class OrganizationsClient {
protected _invitations: InvitationsClient | undefined;
protected _members: MembersClient | undefined;
protected _groups: GroupsClient | undefined;
protected _roles: RolesClient | undefined;

constructor(options: OrganizationsClient.Options) {
this._options = normalizeClientOptionsWithAuth(options);
Expand Down Expand Up @@ -64,6 +66,10 @@ export class OrganizationsClient {
return (this._groups ??= new GroupsClient(this._options));
}

public get roles(): RolesClient {
return (this._roles ??= new RolesClient(this._options));
}

/**
* Retrieve detailed list of all Organizations available in your tenant. For more information, see Auth0 Organizations.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ export * as enabledConnections from "./enabledConnections/index.js";
export * as groups from "./groups/index.js";
export * as invitations from "./invitations/index.js";
export * as members from "./members/index.js";
export * as roles from "./roles/index.js";
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
// This file was auto-generated by Fern from our API Definition.

import type { BaseClientOptions } from "../../../../../../BaseClient.js";
import { normalizeClientOptionsWithAuth, type NormalizedClientOptionsWithAuth } from "../../../../../../BaseClient.js";
import * as core from "../../../../../../core/index.js";
import * as environments from "../../../../../../environments.js";
import { MembersClient } from "../resources/members/client/Client.js";

export declare namespace RolesClient {
export type Options = BaseClientOptions;
}

export class RolesClient {
protected readonly _options: NormalizedClientOptionsWithAuth<RolesClient.Options>;
protected _members: MembersClient | undefined;

constructor(options: RolesClient.Options) {
this._options = normalizeClientOptionsWithAuth(options);
}

public get members(): MembersClient {
return (this._members ??= new MembersClient(this._options));
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export {};
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
export * from "./client/index.js";
export * from "./resources/index.js";
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export * as members from "./members/index.js";
Loading
Loading