Class ClientUsernameService

Hierarchy

  • ClientUsernameService

Constructors

constructor

Methods

createMsgVpnClientUsername createMsgVpnClientUsernameAttribute deleteMsgVpnClientUsername deleteMsgVpnClientUsernameAttribute getMsgVpnClientUsername getMsgVpnClientUsernameAttribute getMsgVpnClientUsernameAttributes getMsgVpnClientUsernames replaceMsgVpnClientUsername updateMsgVpnClientUsername

Constructors

constructor

Methods

Static createMsgVpnClientUsername

  • Create a Client Username object. Create a Client Username object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.

    A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.

    Attribute Identifying Required Read-Only Write-Only Deprecated Opaque
    clientUsername x x
    msgVpnName x x
    password x x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation.

    This has been available since 2.0.

    Returns

    MsgVpnClientUsernameResponse The Client Username object's attributes after being created, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The Client Username object's attributes. *

      • 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<MsgVpnClientUsernameResponse | SempMetaOnlyResponse>

Static createMsgVpnClientUsernameAttribute

  • Create a Client Username Attribute object. Create a Client Username Attribute object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.

    A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping.

    Attribute Identifying Required Read-Only Write-Only Deprecated Opaque
    attributeName x x
    attributeValue x x
    clientUsername x x
    msgVpnName x x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation.

    This has been available since 2.27.

    Returns

    MsgVpnClientUsernameAttributeResponse The Client Username Attribute object's attributes after being created, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The Client Username Attribute object's attributes. *

      • clientUsername: string

        The name of the Client Username. *

      • 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<MsgVpnClientUsernameAttributeResponse | SempMetaOnlyResponse>

Static deleteMsgVpnClientUsername

  • Delete a Client Username object. Delete a Client Username object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.

    A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.

    A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation.

    This has been available since 2.0.

    Returns

    SempMetaOnlyResponse The request metadata.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          clientUsername: string;
          msgVpnName: string;
          xContextId?: string;
      }
      • clientUsername: string

        The name of the Client Username. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<SempMetaOnlyResponse>

Static deleteMsgVpnClientUsernameAttribute

  • Delete a Client Username Attribute object. Delete a Client Username Attribute object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.

    A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping.

    A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation.

    This has been available since 2.27.

    Returns

    SempMetaOnlyResponse The request metadata.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          attributeName: string;
          attributeValue: string;
          clientUsername: string;
          msgVpnName: string;
          xContextId?: string;
      }
      • attributeName: string

        The name of the Attribute. *

      • attributeValue: string

        The value of the Attribute. *

      • clientUsername: string

        The name of the Client Username. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<SempMetaOnlyResponse>

Static getMsgVpnClientUsername

  • Get a Client Username object. Get a Client Username object.

    A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.

    Attribute Identifying Write-Only Deprecated Opaque
    clientUsername x
    msgVpnName x
    password x x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.

    This has been available since 2.0.

    Returns

    MsgVpnClientUsernameResponse The Client Username object's attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The name of the Client Username. *

      • 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<MsgVpnClientUsernameResponse | SempMetaOnlyResponse>

Static getMsgVpnClientUsernameAttribute

  • Get a Client Username Attribute object. Get a Client Username Attribute object.

    A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping.

    Attribute Identifying Write-Only Deprecated Opaque
    attributeName x
    attributeValue x
    clientUsername x
    msgVpnName x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.

    This has been available since 2.27.

    Returns

    MsgVpnClientUsernameAttributeResponse The Client Username Attribute object's attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The name of the Attribute. *

      • attributeValue: string

        The value of the Attribute. *

      • clientUsername: string

        The name of the Client Username. *

      • 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<MsgVpnClientUsernameAttributeResponse | SempMetaOnlyResponse>

Static getMsgVpnClientUsernameAttributes

  • Get a list of Client Username Attribute objects. Get a list of Client Username Attribute objects.

    A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping.

    Attribute Identifying Write-Only Deprecated Opaque
    attributeName x
    attributeValue x
    clientUsername x
    msgVpnName x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.

    This has been available since 2.27.

    Returns

    MsgVpnClientUsernameAttributesResponse The list of Client Username Attribute objects' attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The name of the Client Username. *

      • 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. *

      • 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 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<MsgVpnClientUsernameAttributesResponse | SempMetaOnlyResponse>

Static getMsgVpnClientUsernames

  • Get a list of Client Username objects. Get a list of Client Username objects.

    A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.

    Attribute Identifying Write-Only Deprecated Opaque
    clientUsername x
    msgVpnName x
    password x x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.

    This has been available since 2.0.

    Returns

    MsgVpnClientUsernamesResponse The list of Client Username objects' attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          count?: number;
          cursor?: string;
          msgVpnName: 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. *

      • 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 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<MsgVpnClientUsernamesResponse | SempMetaOnlyResponse>

Static replaceMsgVpnClientUsername

  • Replace a Client Username object. Replace a Client Username object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.

    A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.

    Attribute Identifying Const Read-Only Write-Only Requires-Disable Deprecated Opaque
    aclProfileName x
    clientProfileName x
    clientUsername x x
    msgVpnName x x
    password x x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation.

    This has been available since 2.0.

    Returns

    MsgVpnClientUsernameResponse The Client Username object's attributes after being replaced, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The Client Username object's attributes. *

      • clientUsername: string

        The name of the Client Username. *

      • 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<MsgVpnClientUsernameResponse | SempMetaOnlyResponse>

Static updateMsgVpnClientUsername

  • Update a Client Username object. Update a Client Username object. Any attribute missing from the request will be left unchanged.

    A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.

    Attribute Identifying Read-Only Write-Only Requires-Disable Deprecated Opaque
    aclProfileName x
    clientProfileName x
    clientUsername x x
    msgVpnName x x
    password x x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation.

    This has been available since 2.0.

    Returns

    MsgVpnClientUsernameResponse The Client Username object's attributes after being updated, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The Client Username object's attributes. *

      • clientUsername: string

        The name of the Client Username. *

      • 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<MsgVpnClientUsernameResponse | SempMetaOnlyResponse>

Settings

Member Visibility

Theme