Class ResourceServers

Index

Constructors

constructor

new ResourceServers(_options: ResourceServers.Options): ResourceServers
Parameters
- _options: ResourceServers.Options
Returns ResourceServers

Methods

list

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

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.resourceServers.list()
```

create

create(
request: Management.CreateResourceServerRequestContent,
requestOptions?: ResourceServers.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: Management.CreateResourceServerRequestContent
- OptionalrequestOptions: ResourceServers.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"
    })
```

get

get(
    id: string,
    request?: Management.GetResourceServerRequestParameters,
    requestOptions?: ResourceServers.RequestOptions,
): HttpResponsePromise<GetResourceServerResponseContent>
Retrieve API details with the given ID.
Parameters
- id: string
  ID or audience of the resource server to retrieve.
- request: Management.GetResourceServerRequestParameters = {}
- OptionalrequestOptions: ResourceServers.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")
```

delete

delete(
id: string,
requestOptions?: ResourceServers.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: ResourceServers.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?: Management.UpdateResourceServerRequestContent,
    requestOptions?: ResourceServers.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: Management.UpdateResourceServerRequestContent = {}
- OptionalrequestOptions: ResourceServers.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")
```

`Protected`_getAuthorizationHeader

_getAuthorizationHeader(): Promise<string>
Returns Promise<string>

Properties

`Protected` `Readonly`_options

_options: ResourceServers.Options

Class ResourceServers

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns ResourceServers

Methods

list

Parameters

Returns Promise<Page<ResourceServer>>

Throws

Throws

Throws

Throws

Example

create

Parameters

Returns HttpResponsePromise<CreateResourceServerResponseContent>

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

Protected_getAuthorizationHeader

Returns Promise<string>

Properties

Protected Readonly_options

Settings

On This Page

`Protected`_getAuthorizationHeader

`Protected` `Readonly`_options