Type alias MsgVpnRestDeliveryPointRestConsumer

MsgVpnRestDeliveryPointRestConsumer: {
    authenticationAwsAccessKeyId?: string;
    authenticationAwsRegion?: string;
    authenticationAwsSecretAccessKey?: string;
    authenticationAwsService?: string;
    authenticationClientCertContent?: string;
    authenticationClientCertPassword?: string;
    authenticationHttpBasicPassword?: string;
    authenticationHttpBasicUsername?: string;
    authenticationHttpHeaderName?: string;
    authenticationHttpHeaderValue?: string;
    authenticationOauthClientId?: string;
    authenticationOauthClientScope?: string;
    authenticationOauthClientSecret?: string;
    authenticationOauthClientTokenEndpoint?: string;
    authenticationOauthClientTokenExpiryDefault?: number;
    authenticationOauthJwtSecretKey?: string;
    authenticationOauthJwtTokenEndpoint?: string;
    authenticationOauthJwtTokenExpiryDefault?: number;
    authenticationScheme?: MsgVpnRestDeliveryPointRestConsumer.authenticationScheme;
    enabled?: boolean;
    httpMethod?: httpMethod;
    localInterface?: string;
    maxPostWaitTime?: number;
    msgVpnName?: string;
    outgoingConnectionCount?: number;
    remoteHost?: string;
    remotePort?: number;
    restConsumerName?: string;
    restDeliveryPointName?: string;
    retryDelay?: number;
    tlsCipherSuiteList?: string;
    tlsEnabled?: boolean;
}

Type declaration

  • Optional authenticationAwsAccessKeyId?: string

    The AWS access key id. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.26.

  • Optional authenticationAwsRegion?: string

    The AWS region id. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.26.

  • Optional authenticationAwsSecretAccessKey?: string

    The AWS secret access key. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.26.

  • Optional authenticationAwsService?: string

    The AWS service id. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.26.

  • Optional authenticationClientCertContent?: string

    The PEM formatted content for the client certificate that the REST Consumer will present to the REST host. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is "". Available since 2.9.

  • Optional authenticationClientCertPassword?: string

    The password for the client certificate. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is "". Available since 2.9.

  • Optional authenticationHttpBasicPassword?: string

    The password for the username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

  • Optional authenticationHttpBasicUsername?: string

    The username that the REST Consumer will use to login to the REST host. Normally a username is only configured when basic authentication is selected for the REST Consumer. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

  • Optional authenticationHttpHeaderName?: string

    The authentication header name. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.15.

  • Optional authenticationHttpHeaderValue?: string

    The authentication header value. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.15.

  • Optional authenticationOauthClientId?: string

    The OAuth client ID. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.19.

  • Optional authenticationOauthClientScope?: string

    The OAuth scope. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.19.

  • Optional authenticationOauthClientSecret?: string

    The OAuth client secret. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.19.

  • Optional authenticationOauthClientTokenEndpoint?: string

    The OAuth token endpoint URL that the REST Consumer will use to request a token for login to the REST host. Must begin with "https". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.19.

  • Optional authenticationOauthClientTokenExpiryDefault?: number

    The default expiry time for a token, in seconds. Only used when the token endpoint does not return an expiry time. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 900. Available since 2.30.

  • Optional authenticationOauthJwtSecretKey?: string

    The OAuth secret key used to sign the token request JWT. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.21.

  • Optional authenticationOauthJwtTokenEndpoint?: string

    The OAuth token endpoint URL that the REST Consumer will use to request a token for login to the REST host. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.21.

  • Optional authenticationOauthJwtTokenExpiryDefault?: number

    The default expiry time for a token, in seconds. Only used when the token endpoint does not return an expiry time. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 900. Available since 2.30.

  • Optional authenticationScheme?: MsgVpnRestDeliveryPointRestConsumer.authenticationScheme

    The authentication scheme used by the REST Consumer to login to the REST host. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "none". The allowed values and their meaning are:

    "none" - Login with no authentication. This may be useful for anonymous connections or when a REST Consumer does not require authentication.
"http-basic" - Login with a username and optional password according to HTTP Basic authentication as per RFC2616.
"client-certificate" - Login with a client TLS certificate as per RFC5246. Client certificate authentication is only available on TLS connections.
"http-header" - Login with a specified HTTP header.
"oauth-client" - Login with OAuth 2.0 client credentials.
"oauth-jwt" - Login with OAuth (RFC 7523 JWT Profile).
"transparent" - Login using the Authorization header from the message properties, if present. Transparent authentication passes along existing Authorization header metadata instead of discarding it. Note that if the message is coming from a REST producer, the REST service must be configured to forward the Authorization header.
"aws" - Login using AWS Signature Version 4 authentication (AWS4-HMAC-SHA256).
  • Optional enabled?: boolean

    Enable or disable the REST Consumer. When disabled, no connections are initiated or messages delivered to this particular REST Consumer. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

  • Optional httpMethod?: httpMethod

    The HTTP method to use (POST or PUT). This is used only when operating in the REST service "messaging" mode and is ignored in "gateway" mode. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "post". The allowed values and their meaning are:

    "post" - Use the POST HTTP method.
"put" - Use the PUT HTTP method.

    Available since 2.17.

  • Optional localInterface?: string

    The interface that will be used for all outgoing connections associated with the REST Consumer. When unspecified, an interface is automatically chosen. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

  • Optional maxPostWaitTime?: number

    The maximum amount of time (in seconds) to wait for an HTTP POST response from the REST Consumer. Once this time is exceeded, the TCP connection is reset. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 30.

  • Optional msgVpnName?: string

    The name of the Message VPN.

  • Optional outgoingConnectionCount?: number

    The number of concurrent TCP connections open to the REST Consumer. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 3.

  • Optional remoteHost?: string

    The IP address or DNS name to which the broker is to connect to deliver messages for the REST Consumer. A host value must be configured for the REST Consumer to be operationally up. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

  • Optional remotePort?: number

    The port associated with the host of the REST Consumer. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 8080.

  • Optional restConsumerName?: string

    The name of the REST Consumer.

  • Optional restDeliveryPointName?: string

    The name of the REST Delivery Point.

  • Optional retryDelay?: number

    The number of seconds that must pass before retrying the remote REST Consumer connection. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 3.

  • Optional tlsCipherSuiteList?: string

    The colon-separated list of cipher suites the REST Consumer uses in its encrypted connection. The value "default" implies all supported suites ordered from most secure to least secure. The list of default cipher suites is available in the tlsCipherSuiteMsgBackboneDefaultList attribute of the Broker object in the Monitoring API. The REST Consumer should choose the first suite from this list that it supports. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "default".

  • Optional tlsEnabled?: boolean

    Enable or disable encryption (TLS) for the REST Consumer. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

Settings

Member Visibility

Theme