Realms
Realms are routing and administrative domains that act as namespaces. All resources in Bondy belong to a Realm.
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.
uristringREQUIREDIMMUTABLEThe realm identifier
descriptionstringREQUIREDA textual description of the realm.
is_prototypebooleanREQUIREDIf 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:
falseprototype_uriuriIMMUTABLEIf present, this it the URI of the the realm prototype this realm inherits some of its behaviour and features from.
is_sso_realmbooleanREQUIREDIf true this realm is an SSO Realm. Once a realm has been designated as an SSO realm it cannot be changed.
Default:
falsesso_realm_uriuriIMMUTABLEIf 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_connectionsbooleanREQUIREDIf true this realm is allowing connections from clients. It is normally set to false when the realm is an SSO Realm. Prototype realms never allow connections.
Default: undefined
authmethodsarray[string]REQUIREDThe list of the authentication methods allowed by this realm. Allowed values: 'anonymous', 'trust', 'password', 'ticket', 'oauth2', 'wampcra', 'cryptosign'
Default:
[]security_enabledbooleanWhether 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_statusstringThe 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 create realm e.g. users, groups, etc.
The object represents as overview of the all realm properties but the available properties are detailed in each particular operation.
uristringREQUIREDIMMUTABLEThe realm identifier
descriptionstringREQUIREDA textual description of the realm.
is_prototypebooleanREQUIREDIf 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:
falseprototype_uriuriIMMUTABLEIf present, this it the URI of the the realm prototype this realm inherits some of its behaviour and features from.
is_sso_realmbooleanREQUIREDIf true this realm is an SSO Realm. Once a realm has been designated as an SSO realm it cannot be changed.
Default:
falsesso_realm_uriuriIMMUTABLEIf 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_connectionsbooleanREQUIREDIf true this realm is allowing connections from clients. It is normally set to false when the realm is an SSO Realm. Prototype realms never allow connections.
Default: undefined
authmethodsarray[string]REQUIREDThe list of the authentication methods allowed by this realm. Allowed values: 'anonymous', 'trust', 'password', 'ticket', 'oauth2', 'wampcra', 'cryptosign'
Default:
[]security_enabledbooleanWhether 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.