Type Alias ApiFactory

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;
}

Type declaration

  • generateAmApi:function
    • generateAmApi(
          resource: ResourceConfig,
          requestOverride?: AxiosRequestConfig,
      ): AxiosInstance

      Generates an AM Axios API instance

      Parameters

      Returns AxiosInstance

      Returns a reaady to use Axios instance

  • generateEnvApi:function
    • generateEnvApi(
          resource: ResourceConfig,
          requestOverride?: AxiosRequestConfig,
      ): AxiosInstance

      Generates an Axios instance for the Identity Cloud Environment API

      Parameters

      Returns AxiosInstance

      Returns a reaady to use Axios instance

  • generateGovernanceApi:function
    • generateGovernanceApi(
          resource: ResourceConfig,
          requestOverride?: AxiosRequestConfig,
      ): AxiosInstance

      Generates an Axios instance for the Identity Cloud Governance API

      Parameters

      Returns AxiosInstance

      Returns a reaady to use Axios instance

  • generateIdmApi:function
    • generateIdmApi(requestOverride?: AxiosRequestConfig): AxiosInstance

      Generates an IDM Axios API instance

      Parameters

      Returns AxiosInstance

      Returns a reaady to use Axios instance

  • generateLogApi:function
    • generateLogApi(requestOverride?: AxiosRequestConfig): AxiosInstance

      Generates a Log API Axios instance

      Parameters

      Returns AxiosInstance

      Returns a reaady to use Axios instance

  • generateLogKeysApi:function
    • generateLogKeysApi(requestOverride?: AxiosRequestConfig): AxiosInstance

      Generates a LogKeys API Axios instance

      Parameters

      Returns AxiosInstance

      Returns a reaady to use Axios instance

  • generateOauth2Api:function
    • generateOauth2Api(
          resource: ResourceConfig,
          requestOverride?: AxiosRequestConfig,
          authenticate?: boolean,
      ): AxiosInstance

      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

  • generateReleaseApi:function
    • generateReleaseApi(
          baseUrl: string,
          requestOverride?: AxiosRequestConfig,
      ): AxiosInstance

      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