Type alias ApiFactory

Type declaration

• generateAmApi:function

  • generateAmApi(resource: ResourceConfig, requestOverride?: AxiosRequestConfig<any>): AxiosInstance

  • Generates an AM Axios API instance

    Parameters

    • resource: ResourceConfig

      Takes an object takes a resource object. example:
    • Optional requestOverride: AxiosRequestConfig<any>

      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

• generateEnvApi:function

  • generateEnvApi(resource: ResourceConfig, requestOverride?: AxiosRequestConfig<any>): AxiosInstance

  • Generates an Axios instance for the Identity Cloud Environment API

    Parameters

    • resource: ResourceConfig

      Resource config object.
    • Optional requestOverride: AxiosRequestConfig<any>

      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

• generateGovernanceApi:function

  • generateGovernanceApi(resource: ResourceConfig, requestOverride?: AxiosRequestConfig<any>): AxiosInstance

  • Generates an Axios instance for the Identity Cloud Governance API

    Parameters

    • resource: ResourceConfig

      Resource config object.
    • Optional requestOverride: AxiosRequestConfig<any>

      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

• generateIdmApi:function

  • generateIdmApi(requestOverride?: AxiosRequestConfig<any>): AxiosInstance

  • Generates an IDM Axios API instance

    Parameters

    • Optional requestOverride: AxiosRequestConfig<any>

      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

• generateLogApi:function

  • generateLogApi(requestOverride?: AxiosRequestConfig<any>): AxiosInstance

  • Generates a Log API Axios instance

    Parameters

    • Optional requestOverride: AxiosRequestConfig<any>

      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

• generateLogKeysApi:function

  • generateLogKeysApi(requestOverride?: AxiosRequestConfig<any>): AxiosInstance

  • Generates a LogKeys API Axios instance

    Parameters

    • Optional requestOverride: AxiosRequestConfig<any>

      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

• generateOauth2Api:function

  • generateOauth2Api(resource: ResourceConfig, requestOverride?: AxiosRequestConfig<any>, authenticate?: boolean): AxiosInstance

  • Generates an OAuth2 Axios API instance

    Parameters

    • resource: ResourceConfig

      Takes a resource object. example:
    • Optional requestOverride: AxiosRequestConfig<any>

      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
    • Optional authenticate: boolean

    Returns AxiosInstance

    Returns a reaady to use Axios instance

• generateReleaseApi:function

  • generateReleaseApi(baseUrl: string, requestOverride?: AxiosRequestConfig<any>): AxiosInstance

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

    Parameters

    • baseUrl: string

      Base URL for the request
    • Optional requestOverride: AxiosRequestConfig<any>

      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