Skip to main content
Version: 1.3.0

Update the gateway connection of a realm

PUT 
/gateway/connection/:realm

Update the gateway connection of a realm

Request​

Path Parameters

    realm stringrequired

Header Parameters

    Authorization string
    X-Forwarded-Proto string
    X-Forwarded-Host string

Body

    localRealmstring
    hoststringrequired

    Possible values: non-empty and <= 255 characters

    portint32

    Possible values: >= 1 and <= 65536

    realmstring
    clientIdstringrequired

    Possible values: non-empty and <= 255 characters

    clientSecretstringrequired

    Possible values: >= 36 characters and <= 36 characters

    securedboolean

    attributeFilters

    object[]

  • Array [

    • matcher

    object

    recursiveboolean

    select

    object

    basicboolean
    accessstring

    Possible values: [PRIVATE, PROTECTED, PUBLIC]

    idsstring[]

    names

    object[]

  • Array [

    • matchstring

    Possible values: [EXACT, BEGIN, END, CONTAINS]

    caseSensitiveboolean
    valuestring
    negateboolean

  • ]

    • parents

    object[]

  • Array [

    • idstring

  • ]

    • paths

    object[]

  • Array [

    • pathstring[]

  • ]

    • realm

    object

    namestring
    userIdsstring[]
    typesstring[]

    attributes

    object

    operatorstring

    Possible values: [AND, OR]

    items

    object[]

  • Array [

    • name

    object

    matchstring

    Possible values: [EXACT, BEGIN, END, CONTAINS]

    caseSensitiveboolean
    valuestring
    negateboolean
    negatedboolean
    pathobject[]

    value

    object

    predicateTypestringrequired

    meta

    object[]

  • Array [

    • name

    object

    matchstring

    Possible values: [EXACT, BEGIN, END, CONTAINS]

    caseSensitiveboolean
    valuestring
    negateboolean
    negatedboolean
    pathobject[]

    value

    object

    predicateTypestringrequired

  • ]

    • previousValue

    object

    predicateTypestringrequired
    timestampOlderThanstring

  • ]

    • groupsundefined[]

    orderBy

    object

    propertystring

    Possible values: [CREATED_ON, FIRST_NAME, LAST_NAME, USERNAME, EMAIL]

    descendingboolean
    limitint32
    durationstring
    deltadouble
    valueChangeboolean
    skipAlwaysboolean
    durationParsedMillisint64

  • ]

    • assetSyncRules

    object

    property name*

    GatewayAssetSyncRule

    excludeAttributesstring[]

    excludeAttributeMeta

    object

    property name*

    string[]

  • Array [

    • string

  • ]

    • addAttributeMeta

    object

    property name*

    MetaMap

    delegate

    object

    property name*

    MetaItemObject

    type

    object

    namestring

    Possible values: Value must match regular expression ^\w+(\[\])?$

    constraints

    object[]

  • Array [

    • messagestring
    typestringrequired

  • ]

    • format

    object

    useGroupingboolean
    minimumIntegerDigitsint32
    minimumFractionDigitsint32
    maximumFractionDigitsint32
    minimumSignificantDigitsint32
    maximumSignificantDigitsint32
    asBooleanboolean
    asDateboolean
    asSliderboolean
    resolutionnumber
    dateStylestring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    timeStylestring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    dayPeriodstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    hour12boolean
    iso8601boolean
    weekdaystring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    erastring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    yearstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    monthstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    weekstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    daystring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    hourstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    minutestring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    secondstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    fractionalSecondDigitsint32
    timeZoneNamestring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    momentJsFormatstring
    asNumberboolean
    asOnOffboolean
    asPressedReleasedboolean
    asOpenClosedboolean
    asMomentaryboolean
    multilineboolean
    unitsstring[]
    arrayDimensionsint32
    metaUseOnlyboolean
    jsonTypestring
    valueobject
    namestringrequired

    Possible values: Value must match regular expression ^\w+$

    property name*

    MetaItemObject

    type

    object

    namestring

    Possible values: Value must match regular expression ^\w+(\[\])?$

    constraints

    object[]

  • Array [

    • messagestring
    typestringrequired

  • ]

    • format

    object

    useGroupingboolean
    minimumIntegerDigitsint32
    minimumFractionDigitsint32
    maximumFractionDigitsint32
    minimumSignificantDigitsint32
    maximumSignificantDigitsint32
    asBooleanboolean
    asDateboolean
    asSliderboolean
    resolutionnumber
    dateStylestring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    timeStylestring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    dayPeriodstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    hour12boolean
    iso8601boolean
    weekdaystring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    erastring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    yearstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    monthstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    weekstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    daystring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    hourstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    minutestring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    secondstring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    fractionalSecondDigitsint32
    timeZoneNamestring

    Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

    momentJsFormatstring
    asNumberboolean
    asOnOffboolean
    asPressedReleasedboolean
    asOpenClosedboolean
    asMomentaryboolean
    multilineboolean
    unitsstring[]
    arrayDimensionsint32
    metaUseOnlyboolean
    jsonTypestring
    valueobject
    namestringrequired

    Possible values: Value must match regular expression ^\w+$

    disabledboolean

Responses​

default response

Schema

    any