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

    Type Alias ApiFactory

    type ApiFactory = {
        generateAmApi(
            resource: ResourceConfig,
            requestOverride?: AxiosRequestConfig,
        ): AxiosInstance;
        generateEnvApi(
            resource: ResourceConfig,
            requestOverride?: AxiosRequestConfig,
        ): AxiosInstance;
        generateGovernanceApi(
            resource: ResourceConfig,
            requestOverride?: AxiosRequestConfig,
        ): AxiosInstance;
        generateIdmApi(requestOverride?: AxiosRequestConfig): AxiosInstance;
        generateLogApi(requestOverride?: AxiosRequestConfig): AxiosInstance;
        generateLogKeysApi(requestOverride?: AxiosRequestConfig): AxiosInstance;
        generateOauth2Api(
            resource: ResourceConfig,
            requestOverride?: AxiosRequestConfig,
            authenticate?: boolean,
        ): AxiosInstance;
        generateReleaseApi(
            baseUrl: string,
            requestOverride?: AxiosRequestConfig,
        ): AxiosInstance;
    }
    Index

    Methods

    generateAmApi generateEnvApi generateGovernanceApi generateIdmApi generateLogApi generateLogKeysApi generateOauth2Api generateReleaseApi

    Methods

    • Generates an AM Axios API instance

      Parameters

      Returns AxiosInstance

      Returns a reaady to use Axios instance

    • Generates an Axios instance for the Identity Cloud Environment API

      Parameters

      Returns AxiosInstance

      Returns a reaady to use Axios instance

    • Generates an Axios instance for the Identity Cloud Governance API

      Parameters

      Returns AxiosInstance

      Returns a reaady to use Axios instance

    • Generates an IDM Axios API instance

      Parameters

      Returns AxiosInstance

      Returns a reaady to use Axios instance

    • Generates a Log API Axios instance

      Parameters

      Returns AxiosInstance

      Returns a reaady to use Axios instance

    • Generates a LogKeys API Axios instance

      Parameters

      Returns AxiosInstance

      Returns a reaady to use Axios instance

    • Generates an OAuth2 Axios API instance

      Parameters

      • resource: ResourceConfig

        Takes a resource object. example:

      • OptionalrequestOverride: AxiosRequestConfig

        Takes an object of AXIOS parameters that can be used to either add on extra information or override default properties https://github.com/axios/axios#request-config

      • Optionalauthenticate: boolean

      Returns AxiosInstance

      Returns a reaady to use Axios instance

    • Generates a release (Github or Npm) Axios API instance

      Parameters

      • baseUrl: string

        Base URL for the request

      • OptionalrequestOverride: AxiosRequestConfig

        Takes an object of AXIOS parameters that can be used to either add on extra information or override default properties https://github.com/axios/axios#request-config

      Returns AxiosInstance

      Returns a reaady to use Axios instance

    Settings

    Member Visibility

    On This Page

    Methods