StreamGateway_1_0_0
StreamGateway_1_0_0 Document
A stream gateway provides the access policies for the endpoint’s local and wide-area networks to create stream connections between applications running on this endpoint’s local network and another endpoint’s local network.
Name |
Type |
Description |
DATA_TYPE |
string |
Type of this document |
allowed_domains |
array of string |
List of allowed domains. Users creating lan_secrets or accessing tunnels on this gateway must have an identity in one of these domains. |
authentication_timeout_mins |
integer |
Timeout (in minutes) during which a user is required to have authenticated to create a tunnel on this gateway. |
contact_email |
string |
Email address of the support contact for the stream access point |
contact_info |
string |
Other non-email contact information for the stream access point, e.g. phone and mailing address |
deleted |
boolean |
Flag indicating that this gateway has been deleted |
department |
string |
Department which operates the stream access point |
description |
string |
Description of the stream access point |
display_name |
string |
Name of the stream access point |
domain_name |
string |
Read-only DNS domain. |
id |
string <uuid> |
Unique id for this stream gateway |
identity_mappings |
array ( IdentityMapping ) |
List of identity mappings to apply to user identities to determine what connector-specific accounts are available for access. |
info_link |
string |
Link to a web page with more information about the stream access point |
keywords |
array of string |
List of search keywords for the endpoint. Optional. Unicode string, max 1024 characters total across all strings. |
lan_name |
string |
If set, the name of the lan to use when connecting to this streaming gateway. This corresponds to the network_name property associated with lan addresses in nodes associated with this endpoint. |
lan_secret_required |
boolean |
If true, users of this stream gateway must create and use a lan secret to connect to a stream. Otherwise, that step is optional. |
organization |
string |
Organization that operates the stream access point. Optional unicode string, max 1000 characters, no new lines. |
tlsftp_url |
string |
URL for the TLSFTP server used for tunnel control. |
users_allow |
array of string |
List of mapped usernames allowed to access this gateway. |
users_deny |
array of string |
List of mapped usernames denied access to this gateway. |
{
"DATA_TYPE": "stream_gateway#1.0.0",
"allowed_domains": [
"string"
],
"authentication_timeout_mins": 1,
"contact_email": "string",
"contact_info": "string",
"deleted": true,
"department": "string",
"description": "string",
"display_name": "string",
"domain_name": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identity_mappings": [
{
"DATA_TYPE": "external_identity_mapping#1.0.0",
"command": [
"string"
]
}
],
"info_link": "string",
"keywords": [
"string"
],
"lan_name": "string",
"lan_secret_required": true,
"organization": "string",
"tlsftp_url": "string",
"users_allow": [
"string"
],
"users_deny": [
"string"
]
}