Group ​

Group is a named collection of user or group identifiers. It can have permissions assigned to them directly or via the group membership, but cannot be authenticated.

Description ​

You can use user groups to specify permissions for a collection of users, which makes permissions easier to manage for those users. When you grant a permission to a group, all of the users (and groups) in the group are granted that permission (by transitive rule).

Types ​

input_data() ​

The object used to create or update a group.

The object represents as overview of the all group properties but the available properties are detailed in each particular operation.

group() ​

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

Procedures ​

Add a group to a realm ​

bondy.group.add(realm_uri(), input_data()) -> group() ​

Creates a new group and add it on the provided realm uri.

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

Call ​

Positional Args ​

Keyword Args ​

None.

Result ​

Positional Results ​

Keyword Results ​

None.

Errors ​

• bondy.error.already_exists: when the provided name 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
• bondy.error.no_such_groups: when any of the provided group name doesn't exist.
• bondy.error.not_found: when the provided realm uri is not found.

Examples ​

./wick --url ws://localhost:18080/ws \
--realm com.leapsight.bondy \
call bondy.group.add \
"com.leapsight.test_creation_1" '{"name":"group_1"}' | jq

{
  "groups": [],
  "meta": {},
  "name": "group_1",
  "type": "group",
  "version": "1.1"
}

./wick --url ws://localhost:18080/ws \
--realm com.leapsight.bondy \
call bondy.group.add \
"com.leapsight.test_creation_1" '{"name":"group_2", "groups":["group_1"]}' | jq

{
  "groups": [
    "group_1"
  ],
  "meta": {},
  "name": "group_2",
  "type": "group",
  "version": "1.1"
}

Add a group to a group ​

bondy.group.add_group(realm_uri(), name(), name()) ​

Adds an existing group name to another existing group name.

Call ​

Positional Args ​

Keyword Args ​

None.

Result ​

Positional Results ​

None.

Keyword Results ​

None.

Errors ​

• wamp.error.invalid_argument: when there is an invalid number of positional arguments.
• bondy.error.no_such_groups: when the provided group name doesn't exist.

Examples ​

./wick --url ws://localhost:18080/ws \
--realm com.leapsight.bondy \
call bondy.group.add_group \
"com.leapsight.test_creation_1" "group_1" "group_2"

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

Add groups to a group ​

bondy.group.add_groups(realm_uri(), name(), [name()]) ​

Adds a list of existing group names to another existing group name.

Call ​

Positional Args ​

Keyword Args ​

None.

Result ​

Positional Results ​

None.

Keyword Results ​

None.

Errors ​

• wamp.error.invalid_argument: when there is an invalid number of positional arguments.
• bondy.error.no_such_groups: when any of the provided group names doesn't exist.

Examples ​

./wick --url ws://localhost:18080/ws \
--realm com.leapsight.bondy \
call bondy.group.add_groups \
"com.leapsight.test_creation_1" "group_1" '["group_2","group3"]'

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

Delete a group from a realm ​

bondy.group.delete(realm_uri(), name()) ​

Deletes an existing group from the provided realm uri.

Publishes an event under topic bondy.group.deleted after the group has been deleted.

Call ​

Positional Args ​

Keyword Args ​

None.

Result ​

Positional Results ​

None.

Keyword Results ​

None.

Errors ​

• bondy.error.unknown_group: when the provided group name is not found.

Examples ​

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

Retrieve a group from a realm ​

bondy.group.get(realm_uri(), name()) -> group() ​

Retrieves the requested group name on the provided realm uri.

Call ​

Positional Args ​

Keyword Args ​

None.

Result ​

Positional Results ​

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

Keyword Results ​

None.

Errors ​

• bondy.error.not_found: when the provided group name is not found.

Examples ​

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

{
  "groups": [
    "group_1"
  ],
  "meta": {},
  "name": "group_2",
  "type": "group",
  "version": "1.1"
}

List all groups from a realm ​

bondy.group.list(realm_uri()) -> [group()] ​

Lists all groups of the provided realm uri.

Call ​

Positional Args ​

Keyword Args ​

None.

Result ​

Positional Results ​

The call result is a single positional argument containing a list of groups.

Keyword Results ​

None.

Errors ​

None.

Examples ​

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

[
  {
    "groups": [],
    "meta": {},
    "name": "anonymous",
    "type": "group",
    "version": "1.1"
  },
  {
    "groups": [],
    "meta": {},
    "name": "group_1",
    "type": "group",
    "version": "1.1"
  }
]

Remove a group from a group ​

bondy.group.remove_group(realm_uri(), name(), name()) ​

Removes an existing group name from another existing group name.

Call ​

Positional Args ​

Keyword Args ​

None.

Result ​

Positional Results ​

None.

Keyword Results ​

None.

Errors ​

• wamp.error.invalid_argument: when there is an invalid number of positional arguments.
• bondy.error.no_such_groups: when the provided group name doesn't exist.
• bondy.error.not_found: when the provided group name is not found.

Examples ​

./wick --url ws://localhost:18080/ws \
--realm com.leapsight.bondy \
call bondy.group.remove_group \
"com.leapsight.test_creation_1" "group_1" "group_2"

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

Remove groups from a group ​

bondy.group.remove_groups(realm_uri(), name(), [name()]) ​

Removes a list of existing group names from another existing group name.

Call ​

Positional Args ​

Keyword Args ​

None.

Result ​

Positional Results ​

None.

Keyword Results ​

None.

Errors ​

• wamp.error.invalid_argument: when there is an invalid number of positional arguments.
• bondy.error.no_such_groups: when any of the provided group names doesn't exist.

Examples ​

./wick --url ws://localhost:18080/ws \
--realm com.leapsight.bondy \
call bondy.group.remove_groups \
"com.leapsight.test_creation_1" "group_1" '["group_2","group3"]'

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

Update a group into a realm ​

bondy.group.update(realm_uri(), name(), input_data()) -> group() ​

Updates an existing group.

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

Call ​

Positional Args ​

Keyword Args ​

None.

Result ​

Positional Results ​

Keyword Results ​

None.

Errors ​

• wamp.error.invalid_argument: when there is an invalid number of positional arguments.
• 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
• bondy.error.no_such_groups: when any of the provided group name doesn't exist.
• bondy.error.unknown_group: when the provided realm uri is not found.

Examples ​

./wick --url ws://localhost:18080/ws \
--realm com.leapsight.bondy \
call bondy.group.update \
"com.leapsight.test_creation_1" "group_1" '{"groups":["group_2"]}' | jq

{
  "groups": [
    "group_2"
  ],
  "meta": {},
  "name": "group_1",
  "type": "group",
  "version": "1.1"
}

Topics ​

bondy.group.added ​

Positional Results ​

Keyword Results ​

None.

bondy.group.updated ​

Positional Results ​

Keyword Results ​

None.

bondy.group.deleted ​

Positional Results ​

Keyword Results ​

None.