@rockcarver/frodo-lib

Version:

A library to manage ForgeRock Identity Cloud tenants, ForgeOps deployments, and classic deployments.

6 lines • 73.1 kB

HTML

<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Admin | Frodo Library - v3.3.5</title><meta name="description" content="Documentation for Frodo Library"/><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(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://github.com/rockcarver/frodo-lib">Project Home</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Frodo Library - v3.3.5</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" 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></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Frodo Library</a></li><li><a href="../modules/Reference.html">Reference</a></li><li><a href="Reference.Admin.html">Admin</a></li></ul><h1>Type Alias Admin</h1></div><div class="tsd-signature">Admin: { addAutoIdStaticUserMapping(): Promise<void>; createLongLivedToken( clientId: string, clientSecret: string, scope: string, secret: string | boolean, lifetime: number, ): Promise<any>; createOAuth2ClientWithAdminPrivileges( clientId: string, clientSecret: string, ): Promise<void>; executeRfc7523AuthZGrantFlow( clientId: string, iss: string, jwk: <a href="Reference.JwkRsa.html" class="tsd-signature-type tsd-kind-type-alias">JwkRsa</a>, sub: string, scope?: string[], ): Promise<<a href="Reference.AccessTokenResponseType.html" class="tsd-signature-type tsd-kind-type-alias">AccessTokenResponseType</a>>; generateRfc7523AuthZGrantArtefacts( clientId: string, iss: string, jwk?: <a href="Reference.JwkRsa.html" class="tsd-signature-type tsd-kind-type-alias">JwkRsa</a>, sub?: string, scope?: string[], options?: { save: boolean }, ): Promise< { client: <a href="Reference.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</a>; issuer: <a href="Reference.OAuth2TrustedJwtIssuerSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2TrustedJwtIssuerSkeleton</a>; jwk: <a href="Reference.JwkRsa.html" class="tsd-signature-type tsd-kind-type-alias">JwkRsa</a>; jwks: <a href="../interfaces/Reference.JwksInterface.html" class="tsd-signature-type tsd-kind-interface">JwksInterface</a>; }, >; generateRfc7523ClientAuthNArtefacts( clientId: string, aud?: string, jwk?: <a href="Reference.JwkRsa.html" class="tsd-signature-type tsd-kind-type-alias">JwkRsa</a>, options?: { save: boolean }, ): Promise< { client: <a href="Reference.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</a>; jwk: <a href="Reference.JwkRsa.html" class="tsd-signature-type tsd-kind-type-alias">JwkRsa</a>; jwks: <a href="../interfaces/Reference.JwksInterface.html" class="tsd-signature-type tsd-kind-interface">JwksInterface</a>; jwt: any; }, >; grantOAuth2ClientAdminPrivileges(clientId: string): Promise<void>; hideGenericExtensionAttributes( includeCustomized: boolean, dryRun: boolean, ): Promise<void>; listNonOAuth2AdminStaticUserMappings( showProtected: boolean, ): Promise<string[]>; listOAuth2AdminClients(): Promise<string[]>; listOAuth2CustomClients(): Promise<string[]>; removeStaticUserMapping(subject: string): Promise<void>; repairOrgModel( excludeCustomized: boolean, extendPermissions: boolean, dryRun: boolean, ): Promise<void>; revokeOAuth2ClientAdminPrivileges(clientId: string): Promise<void>; showGenericExtensionAttributes( includeCustomized: boolean, dryRun: boolean, ): Promise<void>; trainAA( apiKey: string, apiSecret: string, customUsernames?: string[], customUserAgents?: string[], customIPs?: string[], loginsPerUser?: number, service?: string, ): Promise<void>; }</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>addAutoIdStaticUserMapping<a id="__typeaddautoidstaticusermapping" class="tsd-anchor"></a>:function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typeaddautoidstaticusermapping-1" class="tsd-anchor"></a>addAutoIdStaticUserMapping(): Promise<void><a href="#__typeaddautoidstaticusermapping-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"><h4 class="tsd-returns-title">Returns Promise<void></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated" class="tsd-anchor"></a>Deprecated<a href="#deprecated" 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>Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base. </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/71d65bb4fc39e87f46720693e8ef00cca5586721/src/ops/AdminOps.ts#L112">ops/AdminOps.ts:112</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5>createLongLivedToken<a id="__typecreatelonglivedtoken" class="tsd-anchor"></a>:function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typecreatelonglivedtoken-1" class="tsd-anchor"></a>createLongLivedToken( clientId: string, clientSecret: string, scope: string, secret: string | boolean, lifetime: number, ): Promise<any><a href="#__typecreatelonglivedtoken-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-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li>clientId: string</li><li>clientSecret: string</li><li>scope: string</li><li>secret: string | boolean</li><li>lifetime: number</li></ul></div><h4 class="tsd-returns-title">Returns Promise<any></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated-1" class="tsd-anchor"></a>Deprecated<a href="#deprecated-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>Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base. </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/71d65bb4fc39e87f46720693e8ef00cca5586721/src/ops/AdminOps.ts#L135">ops/AdminOps.ts:135</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5>createOAuth2ClientWithAdminPrivileges<a id="__typecreateoauth2clientwithadminprivileges" class="tsd-anchor"></a>:function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typecreateoauth2clientwithadminprivileges-1" class="tsd-anchor"></a>createOAuth2ClientWithAdminPrivileges( clientId: string, clientSecret: string, ): Promise<void><a href="#__typecreateoauth2clientwithadminprivileges-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-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li>clientId: string</li><li>clientSecret: string</li></ul></div><h4 class="tsd-returns-title">Returns Promise<void></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated-2" class="tsd-anchor"></a>Deprecated<a href="#deprecated-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>Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base. </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/71d65bb4fc39e87f46720693e8ef00cca5586721/src/ops/AdminOps.ts#L127">ops/AdminOps.ts:127</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5>executeRfc7523AuthZGrantFlow<a id="__typeexecuterfc7523authzgrantflow" class="tsd-anchor"></a>:function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typeexecuterfc7523authzgrantflow-1" class="tsd-anchor"></a>executeRfc7523AuthZGrantFlow( clientId: string, iss: string, jwk: <a href="Reference.JwkRsa.html" class="tsd-signature-type tsd-kind-type-alias">JwkRsa</a>, sub: string, scope?: string[], ): Promise<<a href="Reference.AccessTokenResponseType.html" class="tsd-signature-type tsd-kind-type-alias">AccessTokenResponseType</a>><a href="#__typeexecuterfc7523authzgrantflow-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-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li>clientId: string</li><li>iss: string</li><li>jwk: <a href="Reference.JwkRsa.html" class="tsd-signature-type tsd-kind-type-alias">JwkRsa</a></li><li>sub: string</li><li><code class="tsd-tag">Optional</code>scope: string[]</li></ul></div><h4 class="tsd-returns-title">Returns Promise<<a href="Reference.AccessTokenResponseType.html" class="tsd-signature-type tsd-kind-type-alias">AccessTokenResponseType</a>></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/71d65bb4fc39e87f46720693e8ef00cca5586721/src/ops/AdminOps.ts#L61">ops/AdminOps.ts:61</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5>generateRfc7523AuthZGrantArtefacts<a id="__typegeneraterfc7523authzgrantartefacts" class="tsd-anchor"></a>:function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typegeneraterfc7523authzgrantartefacts-1" class="tsd-anchor"></a>generateRfc7523AuthZGrantArtefacts( clientId: string, iss: string, jwk?: <a href="Reference.JwkRsa.html" class="tsd-signature-type tsd-kind-type-alias">JwkRsa</a>, sub?: string, scope?: string[], options?: { save: boolean }, ): Promise< { client: <a href="Reference.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</a>; issuer: <a href="Reference.OAuth2TrustedJwtIssuerSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2TrustedJwtIssuerSkeleton</a>; jwk: <a href="Reference.JwkRsa.html" class="tsd-signature-type tsd-kind-type-alias">JwkRsa</a>; jwks: <a href="../interfaces/Reference.JwksInterface.html" class="tsd-signature-type tsd-kind-interface">JwksInterface</a>; }, ><a href="#__typegeneraterfc7523authzgrantartefacts-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-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li>clientId: string</li><li>iss: string</li><li><code class="tsd-tag">Optional</code>jwk: <a href="Reference.JwkRsa.html" class="tsd-signature-type tsd-kind-type-alias">JwkRsa</a></li><li><code class="tsd-tag">Optional</code>sub: string</li><li><code class="tsd-tag">Optional</code>scope: string[]</li><li><code class="tsd-tag">Optional</code>options: { save: boolean }</li></ul></div><h4 class="tsd-returns-title">Returns Promise< { client: <a href="Reference.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</a>; issuer: <a href="Reference.OAuth2TrustedJwtIssuerSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2TrustedJwtIssuerSkeleton</a>; jwk: <a href="Reference.JwkRsa.html" class="tsd-signature-type tsd-kind-type-alias">JwkRsa</a>; jwks: <a href="../interfaces/Reference.JwksInterface.html" class="tsd-signature-type tsd-kind-interface">JwksInterface</a>; }, ></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/71d65bb4fc39e87f46720693e8ef00cca5586721/src/ops/AdminOps.ts#L48">ops/AdminOps.ts:48</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5>generateRfc7523ClientAuthNArtefacts<a id="__typegeneraterfc7523clientauthnartefacts" class="tsd-anchor"></a>:function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typegeneraterfc7523clientauthnartefacts-1" class="tsd-anchor"></a>generateRfc7523ClientAuthNArtefacts( clientId: string, aud?: string, jwk?: <a href="Reference.JwkRsa.html" class="tsd-signature-type tsd-kind-type-alias">JwkRsa</a>, options?: { save: boolean }, ): Promise< { client: <a href="Reference.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</a>; jwk: <a href="Reference.JwkRsa.html" class="tsd-signature-type tsd-kind-type-alias">JwkRsa</a>; jwks: <a href="../interfaces/Reference.JwksInterface.html" class="tsd-signature-type tsd-kind-interface">JwksInterface</a>; jwt: any; }, ><a href="#__typegeneraterfc7523clientauthnartefacts-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-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li>clientId: string</li><li><code class="tsd-tag">Optional</code>aud: string</li><li><code class="tsd-tag">Optional</code>jwk: <a href="Reference.JwkRsa.html" class="tsd-signature-type tsd-kind-type-alias">JwkRsa</a></li><li><code class="tsd-tag">Optional</code>options: { save: boolean }</li></ul></div><h4 class="tsd-returns-title">Returns Promise< { client: <a href="Reference.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</a>; jwk: <a href="Reference.JwkRsa.html" class="tsd-signature-type tsd-kind-type-alias">JwkRsa</a>; jwks: <a href="../interfaces/Reference.JwksInterface.html" class="tsd-signature-type tsd-kind-interface">JwksInterface</a>; jwt: any; }, ></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/71d65bb4fc39e87f46720693e8ef00cca5586721/src/ops/AdminOps.ts#L68">ops/AdminOps.ts:68</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5>grantOAuth2ClientAdminPrivileges<a id="__typegrantoauth2clientadminprivileges" class="tsd-anchor"></a>:function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typegrantoauth2clientadminprivileges-1" class="tsd-anchor"></a>grantOAuth2ClientAdminPrivileges(clientId: string): Promise<void><a href="#__typegrantoauth2clientadminprivileges-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-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li>clientId: string</li></ul></div><h4 class="tsd-returns-title">Returns Promise<void></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated-3" class="tsd-anchor"></a>Deprecated<a href="#deprecated-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>Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base. </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/71d65bb4fc39e87f46720693e8ef00cca5586721/src/ops/AdminOps.ts#L117">ops/AdminOps.ts:117</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5>hideGenericExtensionAttributes<a id="__typehidegenericextensionattributes" class="tsd-anchor"></a>:function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typehidegenericextensionattributes-1" class="tsd-anchor"></a>hideGenericExtensionAttributes( includeCustomized: boolean, dryRun: boolean, ): Promise<void><a href="#__typehidegenericextensionattributes-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-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li>includeCustomized: boolean</li><li>dryRun: boolean</li></ul></div><h4 class="tsd-returns-title">Returns Promise<void></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated-4" class="tsd-anchor"></a>Deprecated<a href="#deprecated-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>Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base. </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/71d65bb4fc39e87f46720693e8ef00cca5586721/src/ops/AdminOps.ts#L151">ops/AdminOps.ts:151</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5>listNonOAuth2AdminStaticUserMappings<a id="__typelistnonoauth2adminstaticusermappings" class="tsd-anchor"></a>:function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typelistnonoauth2adminstaticusermappings-1" class="tsd-anchor"></a>listNonOAuth2AdminStaticUserMappings(showProtected: boolean): Promise<<span class=