Frodo Library - v4.0.0-10
    Preparing search index...

    Type Alias Admin

    type 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: JwkRsa,
            sub: string,
            scope?: string[],
        ): Promise<AccessTokenResponseType>;
        generateRfc7523AuthZGrantArtefacts(
            clientId: string,
            iss: string,
            jwk?: JwkRsa,
            sub?: string,
            scope?: string[],
            options?: { save: boolean },
        ): Promise<
            {
                client: OAuth2ClientSkeleton;
                issuer: OAuth2TrustedJwtIssuerSkeleton;
                jwk: JwkRsa;
                jwks: JwksInterface;
            },
        >;
        generateRfc7523ClientAuthNArtefacts(
            clientId: string,
            aud?: string,
            jwk?: JwkRsa,
            options?: { save: boolean },
        ): Promise<
            {
                client: OAuth2ClientSkeleton;
                jwk: JwkRsa;
                jwks: JwksInterface;
                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>;
    }
    Index

    Methods

    • Parameters

      • clientId: string
      • Optionalaud: string
      • Optionaljwk: JwkRsa
      • Optionaloptions: { save: boolean }

      Returns Promise<
          {
              client: OAuth2ClientSkeleton;
              jwk: JwkRsa;
              jwks: JwksInterface;
              jwt: any;
          },
      >

    • Parameters

      • apiKey: string
      • apiSecret: string
      • OptionalcustomUsernames: string[]
      • OptionalcustomUserAgents: string[]
      • OptionalcustomIPs: string[]
      • OptionalloginsPerUser: number
      • Optionalservice: string

      Returns Promise<void>

    Deprecated

    • Returns Promise<void>

      Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

    • Parameters

      • clientId: string
      • clientSecret: string
      • scope: string
      • secret: string | boolean
      • lifetime: number

      Returns Promise<any>

      Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

    • Parameters

      • clientId: string
      • clientSecret: string

      Returns Promise<void>

      Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

    • Parameters

      • clientId: string

      Returns Promise<void>

      Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

    • Parameters

      • includeCustomized: boolean
      • dryRun: boolean

      Returns Promise<void>

      Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

    • Parameters

      • showProtected: boolean

      Returns Promise<string[]>

      Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

    • Returns Promise<string[]>

      Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

    • Returns Promise<string[]>

      Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

    • Parameters

      • subject: string

      Returns Promise<void>

      Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

    • Parameters

      • excludeCustomized: boolean
      • extendPermissions: boolean
      • dryRun: boolean

      Returns Promise<void>

      Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

    • Parameters

      • clientId: string

      Returns Promise<void>

      Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

    • Parameters

      • includeCustomized: boolean
      • dryRun: boolean

      Returns Promise<void>

      Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.