Class ResourceServersClient

Index

Constructors

constructor

new ResourceServersClient(options: BaseClientOptions): ResourceServersClient
Parameters
- options: BaseClientOptions
Returns ResourceServersClient

Methods

list

list(
    request?: ListResourceServerRequestParameters,
    requestOptions?: ResourceServersClient.RequestOptions,
): Promise<
    Page<ResourceServer, ListResourceServerOffsetPaginatedResponseContent>,
>
Retrieve details of all APIs associated with your tenant.
Parameters
- request: ListResourceServerRequestParameters = {}
- OptionalrequestOptions: ResourceServersClient.RequestOptions
  Request-specific configuration.
Returns Promise<Page<ResourceServer, ListResourceServerOffsetPaginatedResponseContent>>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.resourceServers.list({
        identifiers: ["identifiers"],
        page: 1,
        per_page: 1,
        include_totals: true,
        include_fields: true
    })
```

create

create(
request: CreateResourceServerRequestContent,
requestOptions?: ResourceServersClient.RequestOptions,
): HttpResponsePromise<CreateResourceServerResponseContent>
Create a new API associated with your tenant. Note that all new APIs must be registered with Auth0. For more information, read APIs.
Parameters
- request: CreateResourceServerRequestContent
- OptionalrequestOptions: ResourceServersClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<CreateResourceServerResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.ConflictError

Throws
Management.TooManyRequestsError
Example
```
await client.resourceServers.create({
        identifier: "identifier"
    })
```

search

search(
    request?: SearchResourceServersRequestParameters,
    requestOptions?: ResourceServersClient.RequestOptions,
): Promise<
    Page<ResourceServerSearchResponse, SearchResourceServersResponseContent>,
>
Search resource servers using SCIM or Lucene filter syntax with low-latency, eventually consistent results. Use the parser parameter to specify "scim" or "lucene" syntax (default: "lucene"). This endpoint provides an alternative to the standard GET /resource-servers endpoint with better performance for complex queries. Results may not reflect recent updates immediately.

The signing_secret field is not supported by this endpoint.
Parameters
- request: SearchResourceServersRequestParameters = {}
- OptionalrequestOptions: ResourceServersClient.RequestOptions
  Request-specific configuration.
Returns Promise<
Page<ResourceServerSearchResponse, SearchResourceServersResponseContent>,
>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError

Throws
Management.InternalServerError

Throws
Management.GatewayTimeoutError
Example
```
await client.resourceServers.search({
        q: "q",
        parser: "scim",
        fields: "fields",
        include_fields: true,
        take: 1,
        from: "from",
        sort: "identifier"
    })
```

get

get(
    id: string,
    request?: GetResourceServerRequestParameters,
    requestOptions?: ResourceServersClient.RequestOptions,
): HttpResponsePromise<GetResourceServerResponseContent>
Retrieve API details with the given ID.
Parameters
- id: string
  ID or audience of the resource server to retrieve.
- request: GetResourceServerRequestParameters = {}
- OptionalrequestOptions: ResourceServersClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetResourceServerResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.resourceServers.get("id", {
        include_fields: true
    })
```

delete

delete(
id: string,
requestOptions?: ResourceServersClient.RequestOptions,
): HttpResponsePromise<void>
Delete an existing API by ID. For more information, read API Settings.
Parameters
- id: string
  ID or the audience of the resource server to delete.
- OptionalrequestOptions: ResourceServersClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.resourceServers.delete("id")
```

update

update(
    id: string,
    request?: UpdateResourceServerRequestContent,
    requestOptions?: ResourceServersClient.RequestOptions,
): HttpResponsePromise<UpdateResourceServerResponseContent>
Change an existing API setting by resource server ID. For more information, read API Settings.
Parameters
- id: string
  ID or audience of the resource server to update.
- request: UpdateResourceServerRequestContent = {}
- OptionalrequestOptions: ResourceServersClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<UpdateResourceServerResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.ConflictError

Throws
Management.TooManyRequestsError
Example
```
await client.resourceServers.update("id")
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Class ResourceServersClient

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns ResourceServersClient

Methods

list

Parameters

Returns Promise<Page<ResourceServer, ListResourceServerOffsetPaginatedResponseContent>>

Throws

Throws

Throws

Throws

Example

create

Parameters

Returns HttpResponsePromise<CreateResourceServerResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

search

Parameters

Returns Promise< Page<ResourceServerSearchResponse, SearchResourceServersResponseContent>,>

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Example

get

Parameters

Returns HttpResponsePromise<GetResourceServerResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

delete

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Example

update

Parameters

Returns HttpResponsePromise<UpdateResourceServerResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

Properties

Protected Readonly_options

Settings

On This Page

Returns Promise<
Page<ResourceServerSearchResponse, SearchResourceServersResponseContent>,
>

`Protected` `Readonly`_options