Realm

Creating, retrieving and managing realms and also enabling, disabling and checking per realm security status.

Realms are routing and administrative domains that act as namespaces. All resources in Bondy belong to a Realm. Messages are routed separately for each individual realm so sessions attached to a realm won’t see message routed on another realm.

Types

realm

The representation of the realm returned by the read or write operations e.g. get, list, create or update.

uristringREQUIREDIMMUTABLE

The realm identifier

descriptionstringREQUIRED

A textual description of the realm.

is_prototypebooleanREQUIRED

If true this realm is a realm used as a prototype. Prototype realms cannot be used by themselves. Once a realm has been designated as a prototype it cannot be changed.

Default: false

prototype_uriuriIMMUTABLE

If present, this it the URI of the the realm prototype this realm inherits some of its behaviour and features from. This is an irreflexive property i.e. a realm cannot have itself as prototype.

is_sso_realmbooleanREQUIRED

If true this realm is an SSO Realm. Once a realm has been designated as an SSO realm it cannot be changed.

Default: false

sso_realm_uriuriIMMUTABLE

If present, this it the URI of the SSO Realm this realm is connected to. Once a realm has been associated with an SSO realm it cannot be changed.

Default: The realm's prototype value if the realm inherits from a prototype (see prototype_uri), otherwise undefined.

allow_connectionsbooleanREQUIRED

If true this realm will allow connections from clients. It is normally set to false when the realm is an SSO Realm.

INFO

Prototype realms never allow connections, so if you set is_prototype to true this property will be assumed to be false.

Default: undefined

authmethodsarray[string]REQUIRED

The list of the authentication methods allowed by this realm. Allowed values: 'anonymous', 'trust', 'password', 'ticket', 'oauth2', 'wampcra', 'cryptosign'

Default: []

security_enabledboolean

Whether security is enabled or not.

Default: undefined

usersarray[User]

A list of user objects.

groupsarray[object]

A list of group objects.

sourcesarray[source]

A list of source objects.

grantsarray[object]

A list of grant objects.

security_statusstring

The string 'enabled' if enabled is true. Otherwise the string is 'disabled'.

input_data

The object used to create or update a realm. Notice this object contains more information than the actually created realm e.g. users, groups, etc.

uristringREQUIREDIMMUTABLE

The realm identifier

descriptionstringREQUIRED

A textual description of the realm.

is_prototypebooleanREQUIRED

If true this realm is a realm used as a prototype. Prototype realms cannot be used by themselves. Once a realm has been designated as a prototype it cannot be changed.

Default: false

prototype_uriuriIMMUTABLE

If present, this it the URI of the the realm prototype this realm inherits some of its behaviour and features from. This is an irreflexive property i.e. a realm cannot have itself as prototype.

is_sso_realmbooleanREQUIRED

If true this realm is an SSO Realm. Once a realm has been designated as an SSO realm it cannot be changed.

Default: false

sso_realm_uriuriIMMUTABLE

If present, this it the URI of the SSO Realm this realm is connected to. Once a realm has been associated with an SSO realm it cannot be changed.

Default: The realm's prototype value if the realm inherits from a prototype (see prototype_uri), otherwise undefined.

allow_connectionsbooleanREQUIRED

If true this realm will allow connections from clients. It is normally set to false when the realm is an SSO Realm.

INFO

Prototype realms never allow connections, so if you set is_prototype to true this property will be assumed to be false.

Default: undefined

authmethodsarray[string]REQUIRED

The list of the authentication methods allowed by this realm. Allowed values: 'anonymous', 'trust', 'password', 'ticket', 'oauth2', 'wampcra', 'cryptosign'

Default: []

security_enabledboolean

Whether security is enabled or not.

Default: undefined

usersarray[User]

A list of user objects.

groupsarray[object]

A list of group objects.

sourcesarray[source]

A list of source objects.

grantsarray[object]

A list of grant objects.

private_keysarray[private_key]

A list of private keys used for signing.

encryption_keysarray[private_key]

A list of private keys used for encryption.

Procedures

Name	URI
Create a realm	`bondy.realm.create`
Retrieve a realm	`bondy.realm.get`
Update a realm	`bondy.realm.update`
List all realms	`bondy.realm.list`
Delete a realm	`bondy.realm.delete`
Retrieve if a realm security is enabled	`bondy.realm.security.is_enabled`
Enable realm security	`bondy.realm.security.enable`
Disable realm security	`bondy.realm.security.disable`
Retrieve a realm security status	`bondy.realm.security.status`

Create a realm

bondy.realm.create(input_data) -> result(realm)

Creates a new realm based on the provided data. The realm is persisted and asynchronously replicated to all the nodes in the cluster.

Publishes an event under topic bondy.realm.created after the realm has been created.

AUTHORIZATION

This call is only available to sessions attached to the Master Realm with wamp.call permission.

Call

Positional Args

0object

The realm configuration data

Keyword Args

None.

Result

Positional Results

0object

The created realm.

Keyword Results

None.

Errors

bondy.error.already_exists: when the provided uri already exists.
bondy.error.missing_required_value: when a required value is not provided
bondy.error.invalid_datatype: when the data type is invalid
bondy.error.invalid_value: when the data value is invalid
bondy.error.invalid_data: when the data values are invalid
wamp.error.invalid_argument: for example when the provided sso_realm_uri property value doesn't exist or there are some inconsistent property values.

Examples

CallResult

bash

./wick --url ws://localhost:18080/ws --realm com.leapsight.bondy \
call bondy.realm.create \
'{
    "uri":"com.leapsight.test_creation_1",
    "description":"A test creation realm"
}' | jq

json

{
  "description": "A test creation realm",
  "is_prototype": false,
  "is_sso_realm": false,
  "password_opts": {
    "params": {
      "iterations": 10000,
      "kdf": "pbkdf2"
    },
    "protocol": "cra"
  },
  "public_keys": [
    {
      "crv": "P-256",
      "kid": "123260399",
      "kty": "EC",
      "x": "cfhg9z_BOPDAEkYDcSFbpJ1jJVqLxTSlrCJDUYRkrxM",
      "y": "zcdy7H1h1FDzwU8RFeuFxFMve9vCHUFnCOpdbMJfc4o"
    },
    {
      "crv": "P-256",
      "kid": "130260278",
      "kty": "EC",
      "x": "EDPzrOPJofWS1pm6WTI1oaNeJ7ITPz6ZjeTzXyl_8sM",
      "y": "Ki46MYcsXNb19XwoqMMenWboBAdILYjY2eOBkaAkeyQ"
    },
    {
      "crv": "P-256",
      "kid": "57089265",
      "kty": "EC",
      "x": "x_i6fqY3YkzSBi60pDOPe6nS-fxcQ4AjkrTUOjyPvhM",
      "y": "8oFJ9bernMMFzcrDBS07QiuL8fIeuqMXT-GrvwKKDZc"
    }
  ],
  "security_status": "enabled",
  "uri": "com.leapsight.test_creation_1"
}

Retrieve a realm

bondy.realm.get(uri) -> result(realm)

Retrieves the requested realm uri.

Call

Positional Args

0uriREQUIRED

The URI of the realm you want to retrieve.

Keyword Args

None.

Result

Positional Results

The call result is a single positional argument containing a realm:

uristringREQUIREDIMMUTABLE

The realm identifier

descriptionstringREQUIRED

A textual description of the realm.

is_prototypebooleanREQUIRED

If true this realm is a realm used as a prototype. Prototype realms cannot be used by themselves. Once a realm has been designated as a prototype it cannot be changed.

Default: false

prototype_uriuriIMMUTABLE

If present, this it the URI of the the realm prototype this realm inherits some of its behaviour and features from. This is an irreflexive property i.e. a realm cannot have itself as prototype.

is_sso_realmbooleanREQUIRED

If true this realm is an SSO Realm. Once a realm has been designated as an SSO realm it cannot be changed.

Default: false

sso_realm_uriuriIMMUTABLE

If present, this it the URI of the SSO Realm this realm is connected to. Once a realm has been associated with an SSO realm it cannot be changed.

Default: The realm's prototype value if the realm inherits from a prototype (see prototype_uri), otherwise undefined.

allow_connectionsbooleanREQUIRED

If true this realm will allow connections from clients. It is normally set to false when the realm is an SSO Realm.

INFO

Prototype realms never allow connections, so if you set is_prototype to true this property will be assumed to be false.

Default: undefined

authmethodsarray[string]REQUIRED

The list of the authentication methods allowed by this realm. Allowed values: 'anonymous', 'trust', 'password', 'ticket', 'oauth2', 'wampcra', 'cryptosign'

Default: []

security_enabledboolean

Whether security is enabled or not.

Default: undefined

usersarray[User]

A list of user objects.

groupsarray[object]

A list of group objects.

sourcesarray[source]

A list of source objects.

grantsarray[object]

A list of grant objects.

security_statusstring

The string 'enabled' if enabled is true. Otherwise the string is 'disabled'.

Keyword Results

None.

Errors

bondy.error.not_found: when the provided uri is not found.

Examples

CallResult

bash

./wick --url ws://localhost:18080/ws --realm com.leapsight.bondy \
call bondy.realm.get "com.leapsight.test_creation_1" | jq

json

{
  "description": "A test creation realm",
  "is_prototype": false,
  "is_sso_realm": false,
  "password_opts": {
    "params": {
      "iterations": 10000,
      "kdf": "pbkdf2"
    },
    "protocol": "cra"
  },
  "public_keys": [
    {
      "crv": "P-256",
      "kid": "123260399",
      "kty": "EC",
      "x": "cfhg9z_BOPDAEkYDcSFbpJ1jJVqLxTSlrCJDUYRkrxM",
      "y": "zcdy7H1h1FDzwU8RFeuFxFMve9vCHUFnCOpdbMJfc4o"
    },
    {
      "crv": "P-256",
      "kid": "130260278",
      "kty": "EC",
      "x": "EDPzrOPJofWS1pm6WTI1oaNeJ7ITPz6ZjeTzXyl_8sM",
      "y": "Ki46MYcsXNb19XwoqMMenWboBAdILYjY2eOBkaAkeyQ"
    },
    {
      "crv": "P-256",
      "kid": "57089265",
      "kty": "EC",
      "x": "x_i6fqY3YkzSBi60pDOPe6nS-fxcQ4AjkrTUOjyPvhM",
      "y": "8oFJ9bernMMFzcrDBS07QiuL8fIeuqMXT-GrvwKKDZc"
    }
  ],
  "security_status": "enabled",
  "uri": "com.leapsight.test_creation_1"
}

Update a realm

bondy.realm.update(uri, input_data) ->
result(realm)

Updates the data of the provided realm uri. The realm is persisted and asynchronously replicated to all the nodes in the cluster.

Publishes an event under topic bondy.realm.updated after the realm has been updated.

Call

Positional Args

0uriREQUIRED

The URI of the realm you want to update.

1object

The realm configuration data

Keyword Args

None.

Result

Positional Results

0object

The updated realm.

Keyword Results

None.

Errors

bondy.error.missing_required_value: when a required value is not provided
bondy.error.invalid_datatype: when the data type is invalid
bondy.error.invalid_value: when the data value is invalid
bondy.error.invalid_data: when the data values are invalid
wamp.error.invalid_argument: for example when the provided sso_realm_uri property value doesn't exist or there are some inconsistent property values.
bondy.error.not_found: when the provided uri is not found.

Examples

CallResult

bash

./wick --url ws://localhost:18080/ws --realm com.leapsight.bondy \
call bondy.realm.update \
"com.leapsight.test_creation_1" \
'{
    "description": "A test updating realm",
    "allow_connections": true,
    "authmethods": ["cryptosign","wampcra","ticket"],
    "grants": [
        {
            "permissions" : [
                "wamp.subscribe",
                "wamp.unsubscribe",
                "wamp.call",
                "wamp.cancel",
                "wamp.publish"
            ],
            "uri" : "",
            "match" : "prefix",
            "roles" : "all"
        }
    ]
}' | jq

json

{
  "allow_connections": true,
  "authmethods": [
    "cryptosign",
    "wampcra",
    "ticket"
  ],
  "description": "A test updating realm",
  "is_prototype": false,
  "is_sso_realm": false,
  "password_opts": {
    "params": {
      "iterations": 10000,
      "kdf": "pbkdf2"
    },
    "protocol": "cra"
  },
  "public_keys": [
    {
      "crv": "P-256",
      "kid": "35794812",
      "kty": "EC",
      "x": "Q4ONdVUBv-C-XEaTGbAN7A0pDsLqtYWkbQcJeSVtz60",
      "y": "cQAI_QemFKuW_4bsJc0kVfhOdDo1yxQVnIkTDuK2sPA"
    },
    {
      "crv": "P-256",
      "kid": "67154376",
      "kty": "EC",
      "x": "kvvohf8yBoPvY8LzWG3mBaa4y3pjMoMamuO81RRix5E",
      "y": "cUBFbCyFfU60-BuQx8eaG9VfbZYrj-4Ip9zbvRJtQ0E"
    },
    {
      "crv": "P-256",
      "kid": "67318382",
      "kty": "EC",
      "x": "GLwRYxvqT18LXKoIXGOYRKHM-CJzycno2OKn1-0pBZM",
      "y": "_GBlnw0VneuhLOkw7hWVB2dNfnpHL53m6pgBThVB_b0"
    }
  ],
  "security_status": "enabled",
  "uri": "com.leapsight.test_creation_1"
}

List all realms

bondy.realm.list() -> result([realm])

Lists all configured realms.

Call

Positional Args

None.

Keyword Args

None.

Result

Positional Results

The call result is a single positional argument containing a list of all realms:

0array[object]

The realms you want to retrieve.

Keyword Results

None.

CallResult

bash

./wick --url ws://localhost:18080/ws --realm com.leapsight.bondy \
call bondy.realm.list | jq

json

[
    {
        "authmethods": [
            "wampcra",
            "anonymous",
            "password",
            "trust"
        ],
        "description": "The Bondy Master realm",
        "is_prototype": false,
        "is_sso_realm": false,
        "password_opts": {
            "params": {
                "iterations": 10000,
                "kdf": "pbkdf2"
            },
            "protocol": "cra"
        },
        "public_keys": [
            {
                "crv": "P-256",
                "kid": "128116552",
                "kty": "EC",
                "x": "3Nl3CmBWDBnOXLPnfdI-tJVZbG_0oGEINrEswDSaaQM",
                "y": "mbistOgdGNfjGuM6E-IdUZ1r245-5H3-yL2BUm005Hg"
            },
            {
                "crv": "P-256",
                "kid": "19671252",
                "kty": "EC",
                "x": "T9hg9GOiJji9VILQyypKta0e3DKlhRrWnK_0aW36Cfk",
                "y": "fnV4QAfattr-ky5xSvc87pM4wfnJcnKS_4EYjqknN48"
            },
            {
                "crv": "P-256",
                "kid": "39128489",
                "kty": "EC",
                "x": "YqI61nD4OpDb2r5dOgkddeClYVGBTXb-2jFSN01Mgq0",
                "y": "sJ_Noey9m_mtFXJLBBdiCQ0xVyhlDKIIKCh8maeWRWc"
            }
        ],
        "security_status": "enabled",
        "uri": "com.leapsight.bondy"
    },
    {
        "allow_connections": true,
        "authmethods": [
            "cryptosign",
            "wampcra",
            "ticket"
        ],
        "description": "A test realm",
        "is_prototype": false,
        "is_sso_realm": false,
        "password_opts": {
            "params": {
                "iterations": 10000,
                "kdf": "pbkdf2"
            },
            "protocol": "cra"
        },
        "public_keys": [
            {
                "crv": "P-256",
                "kid": "33524152",
                "kty": "EC",
                "x": "o1cp0-BEer7-83IJnrLlQF2vMsC4-p865y_PYbUnh0U",
                "y": "m4KH851AIVkxLPnyEPb-HAFPnI4HWzHZDH6uYODgUFg"
            },
            {
                "crv": "P-256",
                "kid": "33806473",
                "kty": "EC",
                "x": "_027ZsIM3qF4meq-NKkcMjfEFXrP_m9Rf4hvRJUFk24",
                "y": "4onurxZAIxqOc4wGSx18Hb8_VM4tepVWoylwwLcYqOY"
            },
            {
                "crv": "P-256",
                "kid": "46076726",
                "kty": "EC",
                "x": "Td_a_OxHKaG9GN90mDN_ztmBoGRgxm37UAXEkv6ONeE",
                "y": "CMLiG2fcHL-uM-VCvg54nflMw3IVtFOUWKIstMcUcEc"
            }
        ],
        "security_status": "enabled",
        "sso_realm_uri": "com.leapsight.sso",
        "uri": "com.leapsight.test_1"
    },
    {
        "allow_connections": true,
        "authmethods": [
            "cryptosign",
            "wampcra",
            "ticket"
        ],
        "description": "A test realm",
        "is_prototype": false,
        "is_sso_realm": false,
        "password_opts": {
            "params": {
                "iterations": 10000,
                "kdf": "pbkdf2"
            },
            "protocol": "cra"
        },
        "public_keys": [
            {
                "crv": "P-256",
                "kid": "122308677",
                "kty": "EC",
                "x": "X1Re0aJaKBYBKavtHHzjVoOcMuB1Il3L--oVBCIVse8",
                "y": "QEJEd36cyMYoh2mZvX6y1TQ1gYf0l89HIj8OZpj9gyE"
            },
            {
                "crv": "P-256",
                "kid": "134200500",
                "kty": "EC",
                "x": "Da6LJMUF91CXBcFbrbQONoviFaobF20o_XVj092LKMY",
                "y": "OyIY99J789NHKfYlhlzK4X5Iux18Ghs5YaJ04vxUwXE"
            },
            {
                "crv": "P-256",
                "kid": "98270293",
                "kty": "EC",
                "x": "ElQOShI0xqJbAT5KJ1MgCMzzr7IlrP9DZFiv5uoQgqQ",
                "y": "MK0COTzwvH9da4aKtAFkoWmvh7fgAUqW_8EXKj5-vCo"
            }
        ],
        "security_status": "enabled",
        "sso_realm_uri": "com.leapsight.sso",
        "uri": "com.leapsight.test_2"
    },
    {
        "allow_connections": false,
        "authmethods": [
            "cryptosign",
            "wampcra"
        ],
        "description": "A test realm",
        "is_prototype": false,
        "is_sso_realm": true,
        "password_opts": {
            "params": {
                "iterations": 10000,
                "kdf": "pbkdf2"
            },
            "protocol": "cra"
        },
        "public_keys": [
            {
                "crv": "P-256",
                "kid": "29257788",
                "kty": "EC",
                "x": "XH0ww1p6w-rEruIA82mkZOCD_zMDJIBfHVrU7AfV_m4",
                "y": "140OhdeBqptXAt1TpTDubrVpkAt3z8Xe5Ca8rmQ_pUw"
            },
            {
                "crv": "P-256",
                "kid": "30467900",
                "kty": "EC",
                "x": "JT3ftrZmD3VyrvxsaRmgcsmaTKE-nrJ0zp5xCh0pnS8",
                "y": "GVr32Te7dAGhKz-JHajksBio4DGfnBXgCRMvZqsQBGI"
            },
            {
                "crv": "P-256",
                "kid": "91434376",
                "kty": "EC",
                "x": "z1MBM-Kmv9m_MfpdJgTR-5SQRe1NCXFX7gBhuvse1_Y",
                "y": "mMZ1AewL2hSGbUtcm2Z06U2_XymNT6D89SP5mvgIyT0"
            }
        ],
        "security_status": "enabled",
        "uri": "com.leapsight.sso"
    },
    {
        "description": "A test realm",
        "is_prototype": false,
        "is_sso_realm": false,
        "password_opts": {
            "params": {
                "iterations": 10000,
                "kdf": "pbkdf2"
            },
            "protocol": "cra"
        },
        "prototype_uri": "com.leapsight.test.proto",
        "public_keys": [
            {
                "crv": "P-256",
                "kid": "109453414",
                "kty": "EC",
                "x": "fPuKjLMb2hyMN_AWX6qAbGbhBSguDICAq-UMBHyVDDE",
                "y": "F2Oi9S_loNMWOWlnMn_LeQvAPI3AUXIPpn-VTt8YNck"
            },
            {
                "crv": "P-256",
                "kid": "70190073",
                "kty": "EC",
                "x": "ZbsvGGWnxq9grIDgEv35K44OtezAvCabRiRNYd1nRU4",
                "y": "aLFBQyLPtGY5jNrOWu2tfDf_YK92KpsEtEKKzIFGZho"
            },
            {
                "crv": "P-256",
                "kid": "71347183",
                "kty": "EC",
                "x": "NcEOakYR-t9U3z5t4Ws3no3nk2YdhszaN-XpSgbgi3E",
                "y": "GhbiXvLZPC8XOUWA-Zo0TKFpXr1Se8dNzrwWNloi1kQ"
            }
        ],
        "security_status": "enabled",
        "uri": "com.leapsight.test.inheritance"
    },
    {
        "authmethods": [
            "cryptosign",
            "wampcra",
            "anonymous",
            "oauth2",
            "password",
            "trust",
            "ticket"
        ],
        "description": "A test realm",
        "is_prototype": false,
        "is_sso_realm": false,
        "password_opts": {
            "params": {
                "iterations": 10000,
                "kdf": "pbkdf2"
            },
            "protocol": "cra"
        },
        "public_keys": [
            {
                "crv": "P-256",
                "kid": "28821883",
                "kty": "EC",
                "x": "35dxB-NVWz4bXcC_XeV-ikfL6Vn3FgsAn6MZDwClOB8",
                "y": "A99cPIU6x1Rxw4IyfcSyu6GxQ4KzQHaStdWP7QKUIVU"
            },
            {
                "crv": "P-256",
                "kid": "5640599",
                "kty": "EC",
                "x": "AEjB2EC5kchCFuylw7Qcna4ERPGzkogcoInYLEQI1Co",
                "y": "5GoNsIhylGs4sogoLP7DOKrdU4OO2p-dwWDz3wVCYSA"
            },
            {
                "crv": "P-256",
                "kid": "81638418",
                "kty": "EC",
                "x": "jHJMWbqcWPemB7X-a1eZ1ctcoTAxdJqffp1Yil_Pbqc",
                "y": "u5mQGe24nprq1rzVvXOMeqk7h7-43AYsMgWIaNxQZTM"
            }
        ],
        "security_status": "enabled",
        "uri": "com.leapsight.test"
    },
    {
        "allow_connections": true,
        "authmethods": [
            "cryptosign",
            "wampcra",
            "ticket"
        ],
        "description": "A test prototype realm",
        "is_prototype": true,
        "is_sso_realm": false,
        "password_opts": {
            "params": {
                "iterations": 10000,
                "kdf": "pbkdf2"
            },
            "protocol": "cra"
        },
        "public_keys": [
            {
                "crv": "P-256",
                "kid": "106052618",
                "kty": "EC",
                "x": "5sP3cIu6I3ZfGB7IfmifEByZ89sLk9d1RK712C_xwek",
                "y": "crYZ5LqCJoHDicylRFQn6kG77L1IgelDysAk1nIceVM"
            },
            {
                "crv": "P-256",
                "kid": "4239631",
                "kty": "EC",
                "x": "_3BNiNCrxNqg4NBhRMIkci0zCBD7fB54y-l_VZ3GT3E",
                "y": "B51Yq27FP7ttwFctWpeG6OK8GIMV6MRSBFDi00EZbhg"
            },
            {
                "crv": "P-256",
                "kid": "74648249",
                "kty": "EC",
                "x": "2Aj7LNfDi1lnc1Xqm5v1X0Lo6PDGbJXjaGnfUI-qZl4",
                "y": "RqNo7Ye0Kdb3y4d08k_aumM5WhD0fkknJL2zn_9AUrI"
            }
        ],
        "security_status": "enabled",
        "sso_realm_uri": "com.leapsight.sso",
        "uri": "com.leapsight.test.proto"
    }
]

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303

Delete a realm

bondy.realm.delete(uri; force=boolean -> result()

Deletes the realm and all its associated objects.

This call fails with an error if the realm has associated users. To override this behaviour use the force option.

ADMIN AUTHORIZATION

This call is only available when the session is attached to the Master Realm

Call

Positional Args

0uriREQUIRED

The URI of the realm you want to delete.

Keyword Args

forceboolean

Force the deletion of the realm, even if the realm still has associated users.

Result

Positional Results

None.

Keyword Results

None.

Errors

bondy.error.not_found: when the provided uri is not found.
bondy.error.active_users: when there are associated users and the force option is false.

Examples

CallCall with force option

bash

./wick --url ws://localhost:18080/ws --realm com.leapsight.bondy \
call bondy.realm.delete "com.leapsight.test_creation_1"

bash

./wick --url ws://localhost:18080/ws --realm com.leapsight.bondy \
call bondy.realm.delete "com.leapsight.test_creation_1" --kwarg force=true

Retrieve if a realm security is enabled

bondy.realm.security.is_enabled(uri) -> results(boolean)

Returns true if security is enabled for the realm identified with uri. Otherwise returns false. Realm security is enabled by default.

Call

Positional Args

0uriREQUIRED

The URI of the realm you want to retrieve if the security is enabled or not.

Keyword Args

None.

Result

Positional Results

The call result is a single positional argument containing true or false

Keyword Results

None.

Errors

bondy.error.not_found: when the provided uri is not found.

Examples

CallResult

bash

./wick --url ws://localhost:18080/ws --realm com.leapsight.bondy \
call bondy.realm.security.is_enabled "com.leapsight.test_creation_1"

json

true

Enable realm security

bondy.realm.security.enable(uri) -> result()

Enables the security for the realm identified with uri.

Call

Positional Args

0uriREQUIRED

The URI of the realm you want to enable the security.

Keyword Args

None.

Result

Positional Results

None.

Keyword Results

None.

Errors

bondy.error.not_found: when the provided uri is not found.

Examples

Call

bash

/wick --url ws://localhost:18080/ws --realm com.leapsight.bondy \
call bondy.realm.security.enable "com.leapsight.test_creation_1"

Disable realm security

bondy.realm.security.disable(uri) -> result()

Disables security for the realm identified with uri.

Danger

Disabling security removes the various authentication and authorization checks that take place when establishing a session, performing operations against a Bondy Realm and/or routing messages. We recommend using this option only during development.

Users, groups, and other security resources remain available for configuration while security is disabled. The changes will be made effective when security is re-enabled.

Realm security is enabled by default.

Call

Positional Args

0uriREQUIRED

The URI of the realm you want to disable the security.

Keyword Args

None.

Result

Positional Results

None.

Keyword Results

None.

Errors

bondy.error.not_found: when the provided uri is not found.

Examples

Call

bash

/wick --url ws://localhost:18080/ws --realm com.leapsight.bondy \
call bondy.realm.security.disable "com.leapsight.test_creation_1"

Retrieve a realm security status

bondy.realm.security.status(uri) -> 'enabled' | 'disabled'

Returns the security status (enabled or disabled) for the realm identified by uri. Realm security is enabled by default.

Call

Positional Args

0uriREQUIRED

The URI of the realm you want to retrieve if the security status.

Keyword Args

None.

Result

Positional Results

The call result is a single positional argument containing the string enabled or disabled.

Keyword Results

None.

Errors

bondy.error.not_found: when the provided uri is not found.

Examples

CallResult

bash

./wick --url ws://localhost:18080/ws --realm com.leapsight.bondy \
call bondy.realm.security.status "com.leapsight.test_creation_1"

json

"enabled"

Topics

Realm Created

bondy.realm.created

Positional Results

0uri

The URI of the realm you have created.

Keyword Results

None.

Realm Updated

bondy.realm.updated

Positional Results

0uri

The URI of the realm you have updated.

Keyword Results

None.

Realm Deleted

bondy.realm.deleted

Positional Results

0uri

The URI of the realm you have deleted.

Keyword Results

None.

Realm ​

Types ​

realm ​

input_data ​

Procedures ​

Create a realm ​

bondy.realm.create(input_data) -> result(realm) ​

Call ​

Positional Args ​

Keyword Args ​

Result ​

Positional Results ​

Keyword Results ​

Errors ​

Examples ​

Retrieve a realm ​

bondy.realm.get(uri) -> result(realm) ​

Call ​

Positional Args ​

Keyword Args ​

Result ​

Positional Results ​

Keyword Results ​

Errors ​

Examples ​

Update a realm ​

bondy.realm.update(uri, input_data) -> result(realm) ​

Call ​

Positional Args ​

Keyword Args ​

Result ​

Positional Results ​

Keyword Results ​

Errors ​

Examples ​

List all realms ​

bondy.realm.list() -> result([realm]) ​

Call ​

Positional Args ​

Keyword Args ​

Result ​

Positional Results ​

Keyword Results ​

Delete a realm ​

bondy.realm.delete(uri; force=boolean -> result() ​

Call ​

Positional Args ​

Keyword Args ​

Result ​

Positional Results ​

Keyword Results ​

Errors ​

Examples ​

Retrieve if a realm security is enabled ​

bondy.realm.security.is_enabled(uri) -> results(boolean) ​

Call ​

Positional Args ​

Keyword Args ​

Result ​

Positional Results ​

Keyword Results ​

Errors ​

Examples ​

Enable realm security ​

bondy.realm.security.enable(uri) -> result() ​

Call ​

Positional Args ​

Keyword Args ​

Result ​

Positional Results ​

Keyword Results ​

Errors ​

Examples ​

Disable realm security ​

bondy.realm.security.disable(uri) -> result() ​

Call ​

Positional Args ​

Keyword Args ​

Result ​

Positional Results ​

Realm

Types

realm

input_data

Procedures

Create a realm

bondy.realm.create(input_data) -> result(realm)

Call

Positional Args

Keyword Args

Result

Positional Results

Keyword Results

Errors

Examples

Retrieve a realm

bondy.realm.get(uri) -> result(realm)

Call

Positional Args

Keyword Args

Result

Positional Results

Keyword Results

Errors

Examples

Update a realm

bondy.realm.update(uri, input_data) ->
result(realm)

Call

Positional Args

Keyword Args

Result

Positional Results

Keyword Results

Errors

Examples

List all realms

bondy.realm.list() -> result([realm])

Call

Positional Args

Keyword Args

Result

Positional Results

Keyword Results

Delete a realm

bondy.realm.delete(uri; force=boolean -> result()

Call

Positional Args

Keyword Args

Result

Positional Results

Keyword Results

Errors

Examples

Retrieve if a realm security is enabled

bondy.realm.security.is_enabled(uri) -> results(boolean)

Call

Positional Args

Keyword Args

Result

Positional Results

Keyword Results

Errors

Examples

Enable realm security

bondy.realm.security.enable(uri) -> result()

Call

Positional Args

Keyword Args

Result

Positional Results

Keyword Results

Errors

Examples

Disable realm security

bondy.realm.security.disable(uri) -> result()

Call

Positional Args

Keyword Args

Result

Positional Results