Class AboutService

Hierarchy

  • AboutService

Constructors

constructor

Methods

getAbout getAboutApi getAboutUser getAboutUserMsgVpn getAboutUserMsgVpns

Constructors

constructor

Methods

Static getAbout

  • Get an About object. Get an About object.

    This provides metadata about the SEMP API, such as the version of the API supported by the broker.

    A SEMP client authorized with a minimum access scope/level of "global/none" is required to perform this operation.

    This has been available since 2.13.

    Returns

    AboutResponse The About object's attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          opaquePassword?: string;
          select?: string[];
          xContextId?: string;
      }
      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<AboutResponse | SempMetaOnlyResponse>

Static getAboutApi

  • Get an API Description object. Get an API Description object.

    The API Description object provides metadata about the SEMP API.

    A SEMP client authorized with a minimum access scope/level of "global/none" is required to perform this operation.

    This has been available since 2.2.

    Returns

    AboutApiResponse The API Description object's attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          opaquePassword?: string;
          select?: string[];
          xContextId?: string;
      }
      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<AboutApiResponse | SempMetaOnlyResponse>

Static getAboutUser

  • Get a User object. Get a User object.

    Session and access level information about the user accessing the SEMP API.

    A SEMP client authorized with a minimum access scope/level of "global/none" is required to perform this operation.

    This has been available since 2.2.

    Returns

    AboutUserResponse The User object's attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          opaquePassword?: string;
          select?: string[];
          xContextId?: string;
      }
      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<AboutUserResponse | SempMetaOnlyResponse>

Static getAboutUserMsgVpn

  • Get a User Message VPN object. Get a User Message VPN object.

    This provides information about the Message VPN access level for the username used to access the SEMP API.

    Attribute Identifying Write-Only Deprecated Opaque
    msgVpnName x

    A SEMP client authorized with a minimum access scope/level of "global/none" is required to perform this operation.

    This has been available since 2.2.

    Returns

    AboutUserMsgVpnResponse The User Message VPN object's attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          xContextId?: string;
      }
      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<AboutUserMsgVpnResponse | SempMetaOnlyResponse>

Static getAboutUserMsgVpns

  • Get a list of User Message VPN objects. Get a list of User Message VPN objects.

    This provides information about the Message VPN access level for the username used to access the SEMP API.

    Attribute Identifying Write-Only Deprecated Opaque
    msgVpnName x

    A SEMP client authorized with a minimum access scope/level of "global/none" is required to perform this operation.

    This has been available since 2.2.

    Returns

    AboutUserMsgVpnsResponse The list of User Message VPN objects' attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          count?: number;
          cursor?: string;
          opaquePassword?: string;
          select?: string[];
          where?: string[];
          xContextId?: string;
      }
      • Optional count?: number

        Limit the count of objects in the response. See the documentation for the count parameter. *

      • Optional cursor?: string

        The cursor, or position, for the next page of objects. See the documentation for the cursor parameter. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional where?: string[]

        Include in the response only objects where certain conditions are true. See the the documentation for the where parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<AboutUserMsgVpnsResponse | SempMetaOnlyResponse>

Settings

Member Visibility

Theme