-
Notifications
You must be signed in to change notification settings - Fork 314
Expand file tree
/
Copy pathmanagement.SDK.ActionsClient.html
More file actions
89 lines (82 loc) · 65.1 KB
/
Copy pathmanagement.SDK.ActionsClient.html
File metadata and controls
89 lines (82 loc) · 65.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ActionsClient | Auth0 Node.js SDK - v5.10.0</title><meta name="description" content="Documentation for Auth0 Node.js SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Auth0 Node.js SDK - v5.10.0</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/management.html">management</a></li><li><a href="../modules/management.SDK.html">SDK</a></li><li><a href="" aria-current="page">ActionsClient</a></li></ul><h1>Class ActionsClient</h1></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="#versions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>versions</span></a>
<a href="#executions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>executions</span></a>
<a href="#modules" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>modules</span></a>
<a href="#triggers" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>triggers</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#list" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list</span></a>
<a href="#create" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create</span></a>
<a href="#get" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get</span></a>
<a href="#delete" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete</span></a>
<a href="#update" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update</span></a>
<a href="#deploy" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>deploy</span></a>
<a href="#test" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>test</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#_options" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_<wbr/>options</span></a>
<a href="#_versions" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_<wbr/>versions</span></a>
<a href="#_executions" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_<wbr/>executions</span></a>
<a href="#_modules" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_<wbr/>modules</span></a>
<a href="#_triggers" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_<wbr/>triggers</span></a>
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Accessors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="versions"><span>versions</span><a href="#versions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="versionsversions"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">versions</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="management.SDK.VersionsClient-1.html" class="tsd-signature-type tsd-kind-class">VersionsClient</a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="management.SDK.VersionsClient-1.html" class="tsd-signature-type tsd-kind-class">VersionsClient</a></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="executions"><span>executions</span><a href="#executions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="executionsexecutions"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">executions</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="management.SDK.ExecutionsClient.html" class="tsd-signature-type tsd-kind-class">ExecutionsClient</a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="management.SDK.ExecutionsClient.html" class="tsd-signature-type tsd-kind-class">ExecutionsClient</a></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="modules"><span>modules</span><a href="#modules" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="modulesmodules"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">modules</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="management.SDK.ModulesClient.html" class="tsd-signature-type tsd-kind-class">ModulesClient</a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="management.SDK.ModulesClient.html" class="tsd-signature-type tsd-kind-class">ModulesClient</a></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="triggers"><span>triggers</span><a href="#triggers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="triggerstriggers"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">triggers</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="management.SDK.TriggersClient.html" class="tsd-signature-type tsd-kind-class">TriggersClient</a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="management.SDK.TriggersClient.html" class="tsd-signature-type tsd-kind-class">TriggersClient</a></h4></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructoractionsclient"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">ActionsClient</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <a href="../types/management.SDK.BaseClientOptions.html" class="tsd-signature-type tsd-kind-type-alias">BaseClientOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">ActionsClient</a><a href="#constructoractionsclient" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <a href="../types/management.SDK.BaseClientOptions.html" class="tsd-signature-type tsd-kind-type-alias">BaseClientOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">ActionsClient</a></h4></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="list"><span>list</span><a href="#list" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="list-1"><span class="tsd-kind-call-signature">list</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/management.Management.ListActionsRequestParameters.html" class="tsd-signature-type tsd-kind-interface">ListActionsRequestParameters</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">requestOptions</span><span class="tsd-signature-symbol">?:</span> <a href="../modules/management.SDK.ActionsClient.html" class="tsd-signature-type tsd-kind-namespace">ActionsClient</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/management.SDK.ActionsClient.RequestOptions.html" class="tsd-signature-type tsd-kind-interface">RequestOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/management.Page.html" class="tsd-signature-type tsd-kind-interface">Page</a><span class="tsd-signature-symbol"><</span><a href="../modules/management.Management.html" class="tsd-signature-type tsd-kind-namespace">Management</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/management.Management.Action.html" class="tsd-signature-type tsd-kind-interface">Action</a><span class="tsd-signature-symbol">,</span> <a href="../interfaces/management.Management.ListActionsPaginatedResponseContent.html" class="tsd-signature-type tsd-kind-interface">ListActionsPaginatedResponseContent</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#list-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieve all actions.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">request</span>: <a href="../interfaces/management.Management.ListActionsRequestParameters.html" class="tsd-signature-type tsd-kind-interface">ListActionsRequestParameters</a><span class="tsd-signature-symbol"> = {}</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">requestOptions</span>: <a href="../modules/management.SDK.ActionsClient.html" class="tsd-signature-type tsd-kind-namespace">ActionsClient</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/management.SDK.ActionsClient.RequestOptions.html" class="tsd-signature-type tsd-kind-interface">RequestOptions</a></span><div class="tsd-comment tsd-typography"><p>Request-specific configuration.</p>
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/management.Page.html" class="tsd-signature-type tsd-kind-interface">Page</a><span class="tsd-signature-symbol"><</span><a href="../modules/management.Management.html" class="tsd-signature-type tsd-kind-namespace">Management</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/management.Management.Action.html" class="tsd-signature-type tsd-kind-interface">Action</a><span class="tsd-signature-symbol">,</span> <a href="../interfaces/management.Management.ListActionsPaginatedResponseContent.html" class="tsd-signature-type tsd-kind-interface">ListActionsPaginatedResponseContent</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws">Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.BadRequestError.html" class="tsd-kind-class">Management.BadRequestError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-1">Throws<a href="#throws-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.UnauthorizedError.html" class="tsd-kind-class">Management.UnauthorizedError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-2">Throws<a href="#throws-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.ForbiddenError.html" class="tsd-kind-class">Management.ForbiddenError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-3">Throws<a href="#throws-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.TooManyRequestsError.html" class="tsd-kind-class">Management.TooManyRequestsError</a></p>
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-4">actions</span><span class="hl-1">.</span><span class="hl-0">list</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">triggerId:</span><span class="hl-1"> </span><span class="hl-2">"post-login"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">actionName:</span><span class="hl-1"> </span><span class="hl-2">"actionName"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">deployed:</span><span class="hl-1"> </span><span class="hl-5">true</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">page:</span><span class="hl-1"> </span><span class="hl-9">1</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">per_page:</span><span class="hl-1"> </span><span class="hl-9">1</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">installed:</span><span class="hl-1"> </span><span class="hl-5">true</span><br/><span class="hl-1"> })</span>
</code><button type="button">Copy</button></pre>
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="create"><span>create</span><a href="#create" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="create-1"><span class="tsd-kind-call-signature">create</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/management.Management.CreateActionRequestContent.html" class="tsd-signature-type tsd-kind-interface">CreateActionRequestContent</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">requestOptions</span><span class="tsd-signature-symbol">?:</span> <a href="../modules/management.SDK.ActionsClient.html" class="tsd-signature-type tsd-kind-namespace">ActionsClient</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/management.SDK.ActionsClient.RequestOptions.html" class="tsd-signature-type tsd-kind-interface">RequestOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="management.SDK.HttpResponsePromise.html" class="tsd-signature-type tsd-kind-class">HttpResponsePromise</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/management.Management.CreateActionResponseContent.html" class="tsd-signature-type tsd-kind-interface">CreateActionResponseContent</a><span class="tsd-signature-symbol">></span><a href="#create-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create an action. Once an action is created, it must be deployed, and then bound to a trigger before it will be executed as part of a flow.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">request</span>: <a href="../interfaces/management.Management.CreateActionRequestContent.html" class="tsd-signature-type tsd-kind-interface">CreateActionRequestContent</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">requestOptions</span>: <a href="../modules/management.SDK.ActionsClient.html" class="tsd-signature-type tsd-kind-namespace">ActionsClient</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/management.SDK.ActionsClient.RequestOptions.html" class="tsd-signature-type tsd-kind-interface">RequestOptions</a></span><div class="tsd-comment tsd-typography"><p>Request-specific configuration.</p>
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="management.SDK.HttpResponsePromise.html" class="tsd-signature-type tsd-kind-class">HttpResponsePromise</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/management.Management.CreateActionResponseContent.html" class="tsd-signature-type tsd-kind-interface">CreateActionResponseContent</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-4">Throws<a href="#throws-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.BadRequestError.html" class="tsd-kind-class">Management.BadRequestError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-5">Throws<a href="#throws-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.UnauthorizedError.html" class="tsd-kind-class">Management.UnauthorizedError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-6">Throws<a href="#throws-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.ForbiddenError.html" class="tsd-kind-class">Management.ForbiddenError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-7">Throws<a href="#throws-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.TooManyRequestsError.html" class="tsd-kind-class">Management.TooManyRequestsError</a></p>
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-1">Example<a href="#example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-4">actions</span><span class="hl-1">.</span><span class="hl-0">create</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">name:</span><span class="hl-1"> </span><span class="hl-2">"name"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">supported_triggers:</span><span class="hl-1"> [{</span><br/><span class="hl-1"> </span><span class="hl-4">id:</span><span class="hl-1"> </span><span class="hl-2">"post-login"</span><br/><span class="hl-1"> }]</span><br/><span class="hl-1"> })</span>
</code><button type="button">Copy</button></pre>
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="get"><span>get</span><a href="#get" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="get-1"><span class="tsd-kind-call-signature">get</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">requestOptions</span><span class="tsd-signature-symbol">?:</span> <a href="../modules/management.SDK.ActionsClient.html" class="tsd-signature-type tsd-kind-namespace">ActionsClient</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/management.SDK.ActionsClient.RequestOptions.html" class="tsd-signature-type tsd-kind-interface">RequestOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="management.SDK.HttpResponsePromise.html" class="tsd-signature-type tsd-kind-class">HttpResponsePromise</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/management.Management.GetActionResponseContent.html" class="tsd-signature-type tsd-kind-interface">GetActionResponseContent</a><span class="tsd-signature-symbol">></span><a href="#get-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieve an action by its ID.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the action to retrieve.</p>
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">requestOptions</span>: <a href="../modules/management.SDK.ActionsClient.html" class="tsd-signature-type tsd-kind-namespace">ActionsClient</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/management.SDK.ActionsClient.RequestOptions.html" class="tsd-signature-type tsd-kind-interface">RequestOptions</a></span><div class="tsd-comment tsd-typography"><p>Request-specific configuration.</p>
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="management.SDK.HttpResponsePromise.html" class="tsd-signature-type tsd-kind-class">HttpResponsePromise</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/management.Management.GetActionResponseContent.html" class="tsd-signature-type tsd-kind-interface">GetActionResponseContent</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-8">Throws<a href="#throws-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.BadRequestError.html" class="tsd-kind-class">Management.BadRequestError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-9">Throws<a href="#throws-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.UnauthorizedError.html" class="tsd-kind-class">Management.UnauthorizedError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-10">Throws<a href="#throws-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.ForbiddenError.html" class="tsd-kind-class">Management.ForbiddenError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-11">Throws<a href="#throws-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.NotFoundError.html" class="tsd-kind-class">Management.NotFoundError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-12">Throws<a href="#throws-12" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.TooManyRequestsError.html" class="tsd-kind-class">Management.TooManyRequestsError</a></p>
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-2">Example<a href="#example-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-4">actions</span><span class="hl-1">.</span><span class="hl-0">get</span><span class="hl-1">(</span><span class="hl-2">"id"</span><span class="hl-1">)</span>
</code><button type="button">Copy</button></pre>
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="delete"><span>delete</span><a href="#delete" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="delete-1"><span class="tsd-kind-call-signature">delete</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/management.Management.DeleteActionRequestParameters.html" class="tsd-signature-type tsd-kind-interface">DeleteActionRequestParameters</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">requestOptions</span><span class="tsd-signature-symbol">?:</span> <a href="../modules/management.SDK.ActionsClient.html" class="tsd-signature-type tsd-kind-namespace">ActionsClient</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/management.SDK.ActionsClient.RequestOptions.html" class="tsd-signature-type tsd-kind-interface">RequestOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="management.SDK.HttpResponsePromise.html" class="tsd-signature-type tsd-kind-class">HttpResponsePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#delete-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Deletes an action and all of its associated versions. An action must be unbound from all triggers before it can be deleted.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the action to delete.</p>
</div></li><li><span><span class="tsd-kind-parameter">request</span>: <a href="../interfaces/management.Management.DeleteActionRequestParameters.html" class="tsd-signature-type tsd-kind-interface">DeleteActionRequestParameters</a><span class="tsd-signature-symbol"> = {}</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">requestOptions</span>: <a href="../modules/management.SDK.ActionsClient.html" class="tsd-signature-type tsd-kind-namespace">ActionsClient</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/management.SDK.ActionsClient.RequestOptions.html" class="tsd-signature-type tsd-kind-interface">RequestOptions</a></span><div class="tsd-comment tsd-typography"><p>Request-specific configuration.</p>
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="management.SDK.HttpResponsePromise.html" class="tsd-signature-type tsd-kind-class">HttpResponsePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-13">Throws<a href="#throws-13" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.BadRequestError.html" class="tsd-kind-class">Management.BadRequestError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-14">Throws<a href="#throws-14" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.UnauthorizedError.html" class="tsd-kind-class">Management.UnauthorizedError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-15">Throws<a href="#throws-15" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.ForbiddenError.html" class="tsd-kind-class">Management.ForbiddenError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-16">Throws<a href="#throws-16" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.NotFoundError.html" class="tsd-kind-class">Management.NotFoundError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-17">Throws<a href="#throws-17" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.TooManyRequestsError.html" class="tsd-kind-class">Management.TooManyRequestsError</a></p>
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-3">Example<a href="#example-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-4">actions</span><span class="hl-1">.</span><span class="hl-0">delete</span><span class="hl-1">(</span><span class="hl-2">"id"</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-4">force:</span><span class="hl-1"> </span><span class="hl-5">true</span><br/><span class="hl-1"> })</span>
</code><button type="button">Copy</button></pre>
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="update"><span>update</span><a href="#update" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="update-1"><span class="tsd-kind-call-signature">update</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/management.Management.UpdateActionRequestContent.html" class="tsd-signature-type tsd-kind-interface">UpdateActionRequestContent</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">requestOptions</span><span class="tsd-signature-symbol">?:</span> <a href="../modules/management.SDK.ActionsClient.html" class="tsd-signature-type tsd-kind-namespace">ActionsClient</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/management.SDK.ActionsClient.RequestOptions.html" class="tsd-signature-type tsd-kind-interface">RequestOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="management.SDK.HttpResponsePromise.html" class="tsd-signature-type tsd-kind-class">HttpResponsePromise</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/management.Management.UpdateActionResponseContent.html" class="tsd-signature-type tsd-kind-interface">UpdateActionResponseContent</a><span class="tsd-signature-symbol">></span><a href="#update-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Update an existing action. If this action is currently bound to a trigger, updating it will <strong>not</strong> affect any user flows until the action is deployed.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the action to update.</p>
</div></li><li><span><span class="tsd-kind-parameter">request</span>: <a href="../interfaces/management.Management.UpdateActionRequestContent.html" class="tsd-signature-type tsd-kind-interface">UpdateActionRequestContent</a><span class="tsd-signature-symbol"> = {}</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">requestOptions</span>: <a href="../modules/management.SDK.ActionsClient.html" class="tsd-signature-type tsd-kind-namespace">ActionsClient</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/management.SDK.ActionsClient.RequestOptions.html" class="tsd-signature-type tsd-kind-interface">RequestOptions</a></span><div class="tsd-comment tsd-typography"><p>Request-specific configuration.</p>
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="management.SDK.HttpResponsePromise.html" class="tsd-signature-type tsd-kind-class">HttpResponsePromise</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/management.Management.UpdateActionResponseContent.html" class="tsd-signature-type tsd-kind-interface">UpdateActionResponseContent</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-18">Throws<a href="#throws-18" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.BadRequestError.html" class="tsd-kind-class">Management.BadRequestError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-19">Throws<a href="#throws-19" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.UnauthorizedError.html" class="tsd-kind-class">Management.UnauthorizedError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-20">Throws<a href="#throws-20" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.ForbiddenError.html" class="tsd-kind-class">Management.ForbiddenError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-21">Throws<a href="#throws-21" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.NotFoundError.html" class="tsd-kind-class">Management.NotFoundError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-22">Throws<a href="#throws-22" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.TooManyRequestsError.html" class="tsd-kind-class">Management.TooManyRequestsError</a></p>
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-4">Example<a href="#example-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-4">actions</span><span class="hl-1">.</span><span class="hl-0">update</span><span class="hl-1">(</span><span class="hl-2">"id"</span><span class="hl-1">)</span>
</code><button type="button">Copy</button></pre>
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deploy"><span>deploy</span><a href="#deploy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="deploy-1"><span class="tsd-kind-call-signature">deploy</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">requestOptions</span><span class="tsd-signature-symbol">?:</span> <a href="../modules/management.SDK.ActionsClient.html" class="tsd-signature-type tsd-kind-namespace">ActionsClient</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/management.SDK.ActionsClient.RequestOptions.html" class="tsd-signature-type tsd-kind-interface">RequestOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="management.SDK.HttpResponsePromise.html" class="tsd-signature-type tsd-kind-class">HttpResponsePromise</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/management.Management.DeployActionResponseContent.html" class="tsd-signature-type tsd-kind-interface">DeployActionResponseContent</a><span class="tsd-signature-symbol">></span><a href="#deploy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Deploy an action. Deploying an action will create a new immutable version of the action. If the action is currently bound to a trigger, then the system will begin executing the newly deployed version of the action immediately. Otherwise, the action will only be executed as a part of a flow once it is bound to that flow.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of an action.</p>
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">requestOptions</span>: <a href="../modules/management.SDK.ActionsClient.html" class="tsd-signature-type tsd-kind-namespace">ActionsClient</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/management.SDK.ActionsClient.RequestOptions.html" class="tsd-signature-type tsd-kind-interface">RequestOptions</a></span><div class="tsd-comment tsd-typography"><p>Request-specific configuration.</p>
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="management.SDK.HttpResponsePromise.html" class="tsd-signature-type tsd-kind-class">HttpResponsePromise</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/management.Management.DeployActionResponseContent.html" class="tsd-signature-type tsd-kind-interface">DeployActionResponseContent</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-23">Throws<a href="#throws-23" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.BadRequestError.html" class="tsd-kind-class">Management.BadRequestError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-24">Throws<a href="#throws-24" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.UnauthorizedError.html" class="tsd-kind-class">Management.UnauthorizedError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-25">Throws<a href="#throws-25" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.ForbiddenError.html" class="tsd-kind-class">Management.ForbiddenError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-26">Throws<a href="#throws-26" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.TooManyRequestsError.html" class="tsd-kind-class">Management.TooManyRequestsError</a></p>
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-5">Example<a href="#example-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-4">actions</span><span class="hl-1">.</span><span class="hl-0">deploy</span><span class="hl-1">(</span><span class="hl-2">"id"</span><span class="hl-1">)</span>
</code><button type="button">Copy</button></pre>
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="test"><span>test</span><a href="#test" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="test-1"><span class="tsd-kind-call-signature">test</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/management.Management.TestActionRequestContent.html" class="tsd-signature-type tsd-kind-interface">TestActionRequestContent</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">requestOptions</span><span class="tsd-signature-symbol">?:</span> <a href="../modules/management.SDK.ActionsClient.html" class="tsd-signature-type tsd-kind-namespace">ActionsClient</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/management.SDK.ActionsClient.RequestOptions.html" class="tsd-signature-type tsd-kind-interface">RequestOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="management.SDK.HttpResponsePromise.html" class="tsd-signature-type tsd-kind-class">HttpResponsePromise</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/management.Management.TestActionResponseContent.html" class="tsd-signature-type tsd-kind-interface">TestActionResponseContent</a><span class="tsd-signature-symbol">></span><a href="#test-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Test an action. After updating an action, it can be tested prior to being deployed to ensure it behaves as expected.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the action to test.</p>
</div></li><li><span><span class="tsd-kind-parameter">request</span>: <a href="../interfaces/management.Management.TestActionRequestContent.html" class="tsd-signature-type tsd-kind-interface">TestActionRequestContent</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">requestOptions</span>: <a href="../modules/management.SDK.ActionsClient.html" class="tsd-signature-type tsd-kind-namespace">ActionsClient</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/management.SDK.ActionsClient.RequestOptions.html" class="tsd-signature-type tsd-kind-interface">RequestOptions</a></span><div class="tsd-comment tsd-typography"><p>Request-specific configuration.</p>
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="management.SDK.HttpResponsePromise.html" class="tsd-signature-type tsd-kind-class">HttpResponsePromise</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/management.Management.TestActionResponseContent.html" class="tsd-signature-type tsd-kind-interface">TestActionResponseContent</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-27">Throws<a href="#throws-27" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.BadRequestError.html" class="tsd-kind-class">Management.BadRequestError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-28">Throws<a href="#throws-28" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.UnauthorizedError.html" class="tsd-kind-class">Management.UnauthorizedError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-29">Throws<a href="#throws-29" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.ForbiddenError.html" class="tsd-kind-class">Management.ForbiddenError</a></p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-30">Throws<a href="#throws-30" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="management.Management.TooManyRequestsError.html" class="tsd-kind-class">Management.TooManyRequestsError</a></p>
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-6">Example<a href="#example-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-4">actions</span><span class="hl-1">.</span><span class="hl-0">test</span><span class="hl-1">(</span><span class="hl-2">"id"</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-4">payload:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">"key"</span><span class="hl-4">:</span><span class="hl-1"> </span><span class="hl-2">"value"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> })</span>
</code><button type="button">Copy</button></pre>
</div></div></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-protected"><h3 class="tsd-anchor-link" id="_options"><code class="tsd-tag">Protected</code> <code class="tsd-tag">Readonly</code><span>_<wbr/>options</span><a href="#_options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_options</span><span class="tsd-signature-symbol">:</span> <a href="../types/management.SDK.NormalizedClientOptionsWithAuth.html" class="tsd-signature-type tsd-kind-type-alias">NormalizedClientOptionsWithAuth</a><span class="tsd-signature-symbol"><</span><a href="../types/management.SDK.BaseClientOptions.html" class="tsd-signature-type tsd-kind-type-alias">BaseClientOptions</a><span class="tsd-signature-symbol">></span></div></section><section class="tsd-panel tsd-member tsd-is-protected"><h3 class="tsd-anchor-link" id="_versions"><code class="tsd-tag">Protected</code><span>_<wbr/>versions</span><a href="#_versions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_versions</span><span class="tsd-signature-symbol">:</span> <a href="management.SDK.VersionsClient-1.html" class="tsd-signature-type tsd-kind-class">VersionsClient</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></div></section><section class="tsd-panel tsd-member tsd-is-protected"><h3 class="tsd-anchor-link" id="_executions"><code class="tsd-tag">Protected</code><span>_<wbr/>executions</span><a href="#_executions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_executions</span><span class="tsd-signature-symbol">:</span> <a href="management.SDK.ExecutionsClient.html" class="tsd-signature-type tsd-kind-class">ExecutionsClient</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></div></section><section class="tsd-panel tsd-member tsd-is-protected"><h3 class="tsd-anchor-link" id="_modules"><code class="tsd-tag">Protected</code><span>_<wbr/>modules</span><a href="#_modules" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_modules</span><span class="tsd-signature-symbol">:</span> <a href="management.SDK.ModulesClient.html" class="tsd-signature-type tsd-kind-class">ModulesClient</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></div></section><section class="tsd-panel tsd-member tsd-is-protected"><h3 class="tsd-anchor-link" id="_triggers"><code class="tsd-tag">Protected</code><span>_<wbr/>triggers</span><a href="#_triggers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_triggers</span><span class="tsd-signature-symbol">:</span> <a href="management.SDK.TriggersClient.html" class="tsd-signature-type tsd-kind-class">TriggersClient</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#versions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>versions</span></a><a href="#executions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>executions</span></a><a href="#modules"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>modules</span></a><a href="#triggers"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>triggers</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#list"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list</span></a><a href="#create"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create</span></a><a href="#get"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get</span></a><a href="#delete"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete</span></a><a href="#update"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update</span></a><a href="#deploy"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>deploy</span></a><a href="#test"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>test</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#_options" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_<wbr/>options</span></a><a href="#_versions" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_<wbr/>versions</span></a><a href="#_executions" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_<wbr/>executions</span></a><a href="#_modules" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_<wbr/>modules</span></a><a href="#_triggers" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_<wbr/>triggers</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Auth0 Node.js SDK - v5.10.0</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>