Documentation

Mistake on this page? Email us

ServerCredentialsApi

Hierarchy

  • ApiBase
    • ServerCredentialsApi

Index

Constructors

constructor

  • Parameters

    • Optional options: ConfigOptions
    • Default value responseHandler: function =¬†null
        • (sdkError: SDKError, response: superagent.Response): any
        • Parameters

          • sdkError: SDKError
          • response: superagent.Response

          Returns any

    Returns ServerCredentialsApi

Methods

complete

  • complete(error: any, response: any, acceptHeader: string, callback?: function): void
  • Parameters

    • error: any
    • response: any
    • acceptHeader: string
    • Optional callback: function
        • Parameters

          Returns any

    Returns void

currentConfig

  • currentConfig(): object
  • Returns the current configuration of this API module

    Returns object

    • apiKey: any
    • host: any

getAllServerCredentials

  • getAllServerCredentials(authorization: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Fetch all (Bootstrap and LWM2M) server credentials. This REST API is intended to be used by customers to fetch all (Bootstrap and LWM2M) server credentials that they will need to use with their clients to connect to bootstrap or LWM2M server. Example usage: curl -X GET "http://api.us-east-1.mbedcloud.com/v3/server-credentials\" -H "accept: application/json" -H "Authorization: Bearer THE_ACCESS_TOKEN"

    Parameters

    • authorization: string

      Bearer {Access Token}.

    • Optional callback: function
    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

getBootstrapServerCredentials

  • getBootstrapServerCredentials(authorization: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Fetch bootstrap server credentials. This REST API is intended to be used by customers to fetch bootstrap server credentials that they will need to use with their clients to connect to bootstrap server. Example usage: curl -X GET "http://api.us-east-1.mbedcloud.com/v3/server-credentials/bootstrap\" -H "accept: application/json" -H "Authorization: Bearer THE_ACCESS_TOKEN"

    Parameters

    • authorization: string

      Bearer {Access Token}.

    • Optional callback: function
    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

getL2M2MServerCredentials

  • getL2M2MServerCredentials(authorization: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Fetch LWM2M server credentials. This REST API is intended to be used by customers to fetch LWM2M server credentials that they will need to use with their clients to connect to LWM2M server. Example usage: curl -X GET "http://api.us-east-1.mbedcloud.com/v3/server-credentials/lwm2m\" -H "accept: application/json" -H "Authorization: Bearer THE_ACCESS_TOKEN"

    Parameters

    • authorization: string

      Bearer {Access Token}.

    • Optional callback: function
    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

request

  • request<T>(options: object, callback?: function): superagent.SuperAgentRequest
  • Type parameters

    • T

    Parameters

    • options: object
      • acceptTypes: Array<string>
      • Optional body?: any
      • contentTypes: Array<string>
      • Optional file?: boolean
      • formParams: __type
      • headers: object
        • [key: string]: string
      • method: string
      • query: __type
      • Optional requestOptions?: object
        • [key: string]: any
      • url: string
      • useFormData: boolean
    • Optional callback: function
        • Parameters

          Returns any

    Returns superagent.SuperAgentRequest