Back to Node Auth0

Class TemplatesClient

docs/classes/management.SDK.TemplatesClient-1.html

5.9.15.7 KB
Original Source

Class TemplatesClient

Index

Constructors

constructor

Methods

getUniversalLoginupdateUniversalLogindeleteUniversalLogin

Properties

_options

Constructors

constructor

new TemplatesClient(options: BaseClientOptions): TemplatesClient

Parameters

Returns TemplatesClient

Methods

getUniversalLogin

getUniversalLogin(
requestOptions?: TemplatesClient.RequestOptions,
): HttpResponsePromise<GetUniversalLoginTemplateResponseContent>

Parameters

Request-specific configuration.

Returns HttpResponsePromise<GetUniversalLoginTemplateResponseContent>

Throws

Management.UnauthorizedError

Throws

Management.PaymentRequiredError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.branding.templates.getUniversalLogin()Copy

updateUniversalLogin

updateUniversalLogin(
request: UpdateUniversalLoginTemplateRequestContent,
requestOptions?: TemplatesClient.RequestOptions,
): HttpResponsePromise<void>

Update the Universal Login branding template.

When content-type header is set to application/json:

{
  "template": "<!DOCTYPE html>{% assign resolved_dir = dir | default: "auto" %}<html lang="{{locale}}" dir="{{resolved_dir}}"><head>{%- auth0:head -%}</head><body class="_widget-auto-layout">{%- auth0:widget -%}</body></html>"
}

When content-type header is set to text/html:

&lt!DOCTYPE html>
{% assign resolved_dir = dir | default: "auto" %}
<html lang="{{locale}}" dir="{{resolved_dir}}">
  <head>
    {%- auth0:head -%}
  </head>
  <body class="_widget-auto-layout">
    {%- auth0:widget -%}
  </body>
</html>

Parameters

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.PaymentRequiredError

Throws

Management.ForbiddenError

Throws

Management.ConflictError

Throws

Management.TooManyRequestsError

Example

await client.branding.templates.updateUniversalLogin("string")Copy

deleteUniversalLogin

deleteUniversalLogin(
requestOptions?: TemplatesClient.RequestOptions,
): HttpResponsePromise<void>

Parameters

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.UnauthorizedError

Throws

Management.PaymentRequiredError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.branding.templates.deleteUniversalLogin()Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

  • Protected
  • Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods getUniversalLoginupdateUniversalLogindeleteUniversalLogin Properties _options