Back to Node Auth0

Class NetworkAclsClient

docs/classes/management.SDK.NetworkAclsClient.html

5.9.110.2 KB
Original Source

Class NetworkAclsClient

Index

Constructors

constructor

Methods

listcreategetsetdeleteupdate

Properties

_options

Constructors

constructor

new NetworkAclsClient(options: BaseClientOptions): NetworkAclsClient

Parameters

Returns NetworkAclsClient

Methods

list

list(
request?: ListNetworkAclsRequestParameters,
requestOptions?: NetworkAclsClient.RequestOptions,
): Promise<
Page<
NetworkAclsResponseContent,
ListNetworkAclsOffsetPaginatedResponseContent,
>,
>

Get all access control list entries for your client.

Parameters

Request-specific configuration.

Returns Promise< Page< NetworkAclsResponseContent, ListNetworkAclsOffsetPaginatedResponseContent, >, >

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.networkAcls.list({ page: 1, per_page: 1, include_totals: true })Copy

create

create(
request: CreateNetworkAclRequestContent,
requestOptions?: NetworkAclsClient.RequestOptions,
): HttpResponsePromise<void>

Create a new access control list for your client.

Parameters

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.ConflictError

Throws

Management.TooManyRequestsError

Throws

Management.InternalServerError

Example

await client.networkAcls.create({ description: "description", active: true, rule: { action: {}, scope: "management" } })Copy

get

get(
id: string,
requestOptions?: NetworkAclsClient.RequestOptions,
): HttpResponsePromise<GetNetworkAclsResponseContent>

Get a specific access control list entry for your client.

Parameters

  • id: string

The id of the access control list to retrieve.

Request-specific configuration.

Returns HttpResponsePromise<GetNetworkAclsResponseContent>

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.networkAcls.get("id")Copy

set

set(
id: string,
request: SetNetworkAclRequestContent,
requestOptions?: NetworkAclsClient.RequestOptions,
): HttpResponsePromise<SetNetworkAclsResponseContent>

Update existing access control list for your client.

Parameters

  • id: string

The id of the ACL to update.

Request-specific configuration.

Returns HttpResponsePromise<SetNetworkAclsResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.networkAcls.set("id", { description: "description", active: true, rule: { action: {}, scope: "management" } })Copy

delete

delete(
id: string,
requestOptions?: NetworkAclsClient.RequestOptions,
): HttpResponsePromise<void>

Delete existing access control list for your client.

Parameters

  • id: string

The id of the ACL to delete

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.networkAcls.delete("id")Copy

update

update(
id: string,
request?: UpdateNetworkAclRequestContent,
requestOptions?: NetworkAclsClient.RequestOptions,
): HttpResponsePromise<UpdateNetworkAclResponseContent>

Update existing access control list for your client.

Parameters

  • id: string

The id of the ACL to update.

Request-specific configuration.

Returns HttpResponsePromise<UpdateNetworkAclResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.networkAcls.update("id")Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

  • Protected
  • Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods listcreategetsetdeleteupdate Properties _options