create_group(group_name, group_id)

Used to create a new group within the RBAC (Role-Based Access Control) system.

ParameterTypeEVMSubstrateDescription
group_namestrRequiredRequiredName of the group to be created.
group_idstrOptionalOptionalID of the group. If not provided, a new ID will be generated (32 characters).

Create Group Code Examples

import os
from dotenv import load_dotenv
from peaq_sdk import Sdk
from peaq_sdk.types import ChainType

load_dotenv()

HTTPS_PEAQ_URL = os.getenv("HTTPS_PEAQ_URL")

sdk = Sdk.create_instance(
    base_url=HTTPS_PEAQ_URL,
    chain_type=ChainType.EVM
)

group_name = "test_group_1"

response = sdk.rbac.create_group(group_name=group_name)

fetch_group(owner, group_id)

Fetches group information from the RBAC system based on the provided group ID and owner’s address.

ParameterTypeEVMSubstrateDescription
ownerstrRequiredRequiredAddress representing the owner of the group.
group_idstrRequiredRequiredID of the group to be fetched (32 characters).

Fetch Group Code Examples

import os
from dotenv import load_dotenv
from peaq_sdk import Sdk
from peaq_sdk.types import ChainType

load_dotenv()

HTTPS_PEAQ_URL = os.getenv("HTTPS_PEAQ_URL")
EVM_ADDRESS = os.getenv("EVM_ADDRESS")

sdk = Sdk.create_instance(
    base_url=HTTPS_PEAQ_URL,
    chain_type=ChainType.EVM
)

group_id = "38c9ccb3-2346-4b25-ab28-51e1e2e3"

response = sdk.rbac.fetch_group(owner=EVM_ADDRESS, group_id=group_id)

fetch_groups(owner)

Used to fetch all the groups associated with the passed owner address.

ParameterTypeEVMSubstrateDescription
ownerstrRequiredRequiredAddress representing the owner of all the fetched groups.

Fetch Groups Code Examples

import os
from dotenv import load_dotenv
from peaq_sdk import Sdk
from peaq_sdk.types import ChainType

load_dotenv()

HTTPS_PEAQ_URL = os.getenv("HTTPS_PEAQ_URL")
EVM_ADDRESS = os.getenv("EVM_ADDRESS")

sdk = Sdk.create_instance(
    base_url=HTTPS_PEAQ_URL,
    chain_type=ChainType.EVM
)

response = sdk.rbac.fetch_groups(owner=EVM_ADDRESS)

update_group(group_id, group_name)

Allows updating the name of an existing group in the RBAC system.

ParameterTypeEVMSubstrateDescription
group_idstrRequiredRequiredID of the group to be updated (32 characters).
group_namestrRequiredRequiredNew name for the group.

Update Group Code Examples

import os
from dotenv import load_dotenv
from peaq_sdk import Sdk
from peaq_sdk.types import ChainType

load_dotenv()

HTTPS_PEAQ_URL = os.getenv("HTTPS_PEAQ_URL")

sdk = Sdk.create_instance(
    base_url=HTTPS_PEAQ_URL,
    chain_type=ChainType.EVM
)

group_id = "d07cd755-8f2f-497f-ad53-9d6cf828"
new_group_name = "updated_group_1"

response = sdk.rbac.update_group(group_id=group_id, group_name=new_group_name)

disable_group(group_id)

Disables a group within the RBAC system. A disabled group cannot be used for new role assignments.

ParameterTypeEVMSubstrateDescription
group_idstrRequiredRequiredID of the group to be disabled (32 characters).

Disable Group Code Examples

import os
from dotenv import load_dotenv
from peaq_sdk import Sdk
from peaq_sdk.types import ChainType

load_dotenv()

HTTPS_PEAQ_URL = os.getenv("HTTPS_PEAQ_URL")

sdk = Sdk.create_instance(
    base_url=HTTPS_PEAQ_URL,
    chain_type=ChainType.EVM
)

group_id = "d07cd755-8f2f-497f-ad53-9d6cf828"

response = sdk.rbac.disable_group(group_id=group_id)

assign_role_to_group(group_id, role_id)

Assigns a role to a group in the RBAC system. This grants all members of the group the permissions associated with the role.

ParameterTypeEVMSubstrateDescription
group_idstrRequiredRequiredID of the group to assign the role to (32 characters).
role_idstrRequiredRequiredID of the role to be assigned (32 characters).

Assign Role to Group Code Examples

import os
from dotenv import load_dotenv
from peaq_sdk import Sdk
from peaq_sdk.types import ChainType

load_dotenv()

HTTPS_PEAQ_URL = os.getenv("HTTPS_PEAQ_URL")

sdk = Sdk.create_instance(
    base_url=HTTPS_PEAQ_URL,
    chain_type=ChainType.EVM
)

group_id = "d07cd755-8f2f-497f-ad53-9d6cf828"
role_id = "0bb60413-ebdd-44fb-ab2c-e7e0714f"

response = sdk.rbac.assign_role_to_group(group_id=group_id, role_id=role_id)

fetch_group_roles(owner, group_id)

Fetches all roles assigned to a specific group in the RBAC system.

ParameterTypeEVMSubstrateDescription
ownerstrRequiredRequiredAddress of the group owner.
group_idstrRequiredRequiredID of the group to fetch roles from (32 characters).

Fetch Group Roles Code Examples

import os
from dotenv import load_dotenv
from peaq_sdk import Sdk
from peaq_sdk.types import ChainType

load_dotenv()

EVM_ADDRESS = os.getenv("EVM_ADDRESS")
HTTPS_PEAQ_URL = os.getenv("HTTPS_PEAQ_URL")
WSS_PEAQ_URL = os.getenv("WSS_PEAQ_URL")

sdk = Sdk.create_instance(
    base_url=HTTPS_PEAQ_URL,
    chain_type=ChainType.EVM
)

group_id = "38c9ccb3-2346-4b25-ab28-51e1e2e3"

response = sdk.rbac.fetch_group_roles(owner=EVM_ADDRESS, group_id=group_id)

unassign_role_to_group(group_id, role_id)

Removes a role assignment from a group in the RBAC system. This revokes the role’s permissions from all group members.

ParameterTypeEVMSubstrateDescription
group_idstrRequiredRequiredID of the group to unassign the role from (32 characters).
role_idstrRequiredRequiredID of the role to be unassigned (32 characters).

Unassign Role to Group Code Examples

import os
from dotenv import load_dotenv
from peaq_sdk import Sdk
from peaq_sdk.types import ChainType

load_dotenv()

HTTPS_PEAQ_URL = os.getenv("HTTPS_PEAQ_URL")

sdk = Sdk.create_instance(
    base_url=HTTPS_PEAQ_URL,
    chain_type=ChainType.EVM
)

group_id = "d07cd755-8f2f-497f-ad53-9d6cf828"
role_id = "0bb60413-ebdd-44fb-ab2c-e7e0714f"

response = sdk.rbac.unassign_role_to_group(group_id=group_id, role_id=role_id)

assign_user_to_group(user_id, group_id)

Assigns a user to a group in the RBAC system. The user will inherit all roles and permissions assigned to the group.

ParameterTypeEVMSubstrateDescription
user_idstrRequiredRequiredID of the user to be assigned to the group (32 characters).
group_idstrRequiredRequiredID of the group to assign the user to (32 characters).

Assign User to Group Code Examples

import os
from dotenv import load_dotenv
from peaq_sdk import Sdk
from peaq_sdk.types import ChainType

load_dotenv()

HTTPS_PEAQ_URL = os.getenv("HTTPS_PEAQ_URL")

sdk = Sdk.create_instance(
    base_url=HTTPS_PEAQ_URL,
    chain_type=ChainType.EVM
)

user_id = "9e8c7866-8435-4b76-8683-709a03c9"
group_id = "d07cd755-8f2f-497f-ad53-9d6cf828"

response = sdk.rbac.assign_user_to_group(user_id=user_id, group_id=group_id)

fetch_user_groups(owner, user_id)

Fetches all groups that a specific user is assigned to in the RBAC system.

ParameterTypeEVMSubstrateDescription
ownerstrRequiredRequiredAddress of the group owner.
user_idstrRequiredRequiredID of the user to fetch groups for (32 characters).

Fetch User Groups Code Examples

import os
from dotenv import load_dotenv
from peaq_sdk import Sdk
from peaq_sdk.types import ChainType

load_dotenv()

EVM_ADDRESS = os.getenv("EVM_ADDRESS")
HTTPS_PEAQ_URL = os.getenv("HTTPS_PEAQ_URL")
WSS_PEAQ_URL = os.getenv("WSS_PEAQ_URL")

sdk = Sdk.create_instance(
    base_url=HTTPS_PEAQ_URL,
    chain_type=ChainType.EVM
)

user_id = "9e8c7866-8435-4b76-8683-709a03c9"

response = sdk.rbac.fetch_user_groups(owner=EVM_ADDRESS, user_id=user_id)

unassign_user_to_group(user_id, group_id)

Removes a user from a group in the RBAC system. The user will lose all roles and permissions associated with the group.

ParameterTypeEVMSubstrateDescription
user_idstrRequiredRequiredID of the user to be unassigned from the group (32 characters).
group_idstrRequiredRequiredID of the group to unassign the user from (32 characters).

Unassign User to Group Code Examples

import os
from dotenv import load_dotenv
from peaq_sdk import Sdk
from peaq_sdk.types import ChainType

load_dotenv()

HTTPS_PEAQ_URL = os.getenv("HTTPS_PEAQ_URL")

sdk = Sdk.create_instance(
    base_url=HTTPS_PEAQ_URL,
    chain_type=ChainType.EVM
)

user_id = "9e8c7866-8435-4b76-8683-709a03c9"
group_id = "d07cd755-8f2f-497f-ad53-9d6cf828"

response = sdk.rbac.unassign_user_to_group(user_id=user_id, group_id=group_id)

create_group(group_name, group_id)

Used to create a new group within the RBAC (Role-Based Access Control) system.

ParameterTypeEVMSubstrateDescription
group_namestrRequiredRequiredName of the group to be created.
group_idstrOptionalOptionalID of the group. If not provided, a new ID will be generated (32 characters).

Create Group Code Examples

import os
from dotenv import load_dotenv
from peaq_sdk import Sdk
from peaq_sdk.types import ChainType

load_dotenv()

HTTPS_PEAQ_URL = os.getenv("HTTPS_PEAQ_URL")

sdk = Sdk.create_instance(
    base_url=HTTPS_PEAQ_URL,
    chain_type=ChainType.EVM
)

group_name = "test_group_1"

response = sdk.rbac.create_group(group_name=group_name)

fetch_group(owner, group_id)

Fetches group information from the RBAC system based on the provided group ID and owner’s address.

ParameterTypeEVMSubstrateDescription
ownerstrRequiredRequiredAddress representing the owner of the group.
group_idstrRequiredRequiredID of the group to be fetched (32 characters).

Fetch Group Code Examples

import os
from dotenv import load_dotenv
from peaq_sdk import Sdk
from peaq_sdk.types import ChainType

load_dotenv()

HTTPS_PEAQ_URL = os.getenv("HTTPS_PEAQ_URL")
EVM_ADDRESS = os.getenv("EVM_ADDRESS")

sdk = Sdk.create_instance(
    base_url=HTTPS_PEAQ_URL,
    chain_type=ChainType.EVM
)

group_id = "38c9ccb3-2346-4b25-ab28-51e1e2e3"

response = sdk.rbac.fetch_group(owner=EVM_ADDRESS, group_id=group_id)

fetch_groups(owner)

Used to fetch all the groups associated with the passed owner address.

ParameterTypeEVMSubstrateDescription
ownerstrRequiredRequiredAddress representing the owner of all the fetched groups.

Fetch Groups Code Examples

import os
from dotenv import load_dotenv
from peaq_sdk import Sdk
from peaq_sdk.types import ChainType

load_dotenv()

HTTPS_PEAQ_URL = os.getenv("HTTPS_PEAQ_URL")
EVM_ADDRESS = os.getenv("EVM_ADDRESS")

sdk = Sdk.create_instance(
    base_url=HTTPS_PEAQ_URL,
    chain_type=ChainType.EVM
)

response = sdk.rbac.fetch_groups(owner=EVM_ADDRESS)

update_group(group_id, group_name)

Allows updating the name of an existing group in the RBAC system.

ParameterTypeEVMSubstrateDescription
group_idstrRequiredRequiredID of the group to be updated (32 characters).
group_namestrRequiredRequiredNew name for the group.

Update Group Code Examples

import os
from dotenv import load_dotenv
from peaq_sdk import Sdk
from peaq_sdk.types import ChainType

load_dotenv()

HTTPS_PEAQ_URL = os.getenv("HTTPS_PEAQ_URL")

sdk = Sdk.create_instance(
    base_url=HTTPS_PEAQ_URL,
    chain_type=ChainType.EVM
)

group_id = "d07cd755-8f2f-497f-ad53-9d6cf828"
new_group_name = "updated_group_1"

response = sdk.rbac.update_group(group_id=group_id, group_name=new_group_name)

disable_group(group_id)

Disables a group within the RBAC system. A disabled group cannot be used for new role assignments.

ParameterTypeEVMSubstrateDescription
group_idstrRequiredRequiredID of the group to be disabled (32 characters).

Disable Group Code Examples

import os
from dotenv import load_dotenv
from peaq_sdk import Sdk
from peaq_sdk.types import ChainType

load_dotenv()

HTTPS_PEAQ_URL = os.getenv("HTTPS_PEAQ_URL")

sdk = Sdk.create_instance(
    base_url=HTTPS_PEAQ_URL,
    chain_type=ChainType.EVM
)

group_id = "d07cd755-8f2f-497f-ad53-9d6cf828"

response = sdk.rbac.disable_group(group_id=group_id)

assign_role_to_group(group_id, role_id)

Assigns a role to a group in the RBAC system. This grants all members of the group the permissions associated with the role.

ParameterTypeEVMSubstrateDescription
group_idstrRequiredRequiredID of the group to assign the role to (32 characters).
role_idstrRequiredRequiredID of the role to be assigned (32 characters).

Assign Role to Group Code Examples

import os
from dotenv import load_dotenv
from peaq_sdk import Sdk
from peaq_sdk.types import ChainType

load_dotenv()

HTTPS_PEAQ_URL = os.getenv("HTTPS_PEAQ_URL")

sdk = Sdk.create_instance(
    base_url=HTTPS_PEAQ_URL,
    chain_type=ChainType.EVM
)

group_id = "d07cd755-8f2f-497f-ad53-9d6cf828"
role_id = "0bb60413-ebdd-44fb-ab2c-e7e0714f"

response = sdk.rbac.assign_role_to_group(group_id=group_id, role_id=role_id)

fetch_group_roles(owner, group_id)

Fetches all roles assigned to a specific group in the RBAC system.

ParameterTypeEVMSubstrateDescription
ownerstrRequiredRequiredAddress of the group owner.
group_idstrRequiredRequiredID of the group to fetch roles from (32 characters).

Fetch Group Roles Code Examples

import os
from dotenv import load_dotenv
from peaq_sdk import Sdk
from peaq_sdk.types import ChainType

load_dotenv()

EVM_ADDRESS = os.getenv("EVM_ADDRESS")
HTTPS_PEAQ_URL = os.getenv("HTTPS_PEAQ_URL")
WSS_PEAQ_URL = os.getenv("WSS_PEAQ_URL")

sdk = Sdk.create_instance(
    base_url=HTTPS_PEAQ_URL,
    chain_type=ChainType.EVM
)

group_id = "38c9ccb3-2346-4b25-ab28-51e1e2e3"

response = sdk.rbac.fetch_group_roles(owner=EVM_ADDRESS, group_id=group_id)

unassign_role_to_group(group_id, role_id)

Removes a role assignment from a group in the RBAC system. This revokes the role’s permissions from all group members.

ParameterTypeEVMSubstrateDescription
group_idstrRequiredRequiredID of the group to unassign the role from (32 characters).
role_idstrRequiredRequiredID of the role to be unassigned (32 characters).

Unassign Role to Group Code Examples

import os
from dotenv import load_dotenv
from peaq_sdk import Sdk
from peaq_sdk.types import ChainType

load_dotenv()

HTTPS_PEAQ_URL = os.getenv("HTTPS_PEAQ_URL")

sdk = Sdk.create_instance(
    base_url=HTTPS_PEAQ_URL,
    chain_type=ChainType.EVM
)

group_id = "d07cd755-8f2f-497f-ad53-9d6cf828"
role_id = "0bb60413-ebdd-44fb-ab2c-e7e0714f"

response = sdk.rbac.unassign_role_to_group(group_id=group_id, role_id=role_id)

assign_user_to_group(user_id, group_id)

Assigns a user to a group in the RBAC system. The user will inherit all roles and permissions assigned to the group.

ParameterTypeEVMSubstrateDescription
user_idstrRequiredRequiredID of the user to be assigned to the group (32 characters).
group_idstrRequiredRequiredID of the group to assign the user to (32 characters).

Assign User to Group Code Examples

import os
from dotenv import load_dotenv
from peaq_sdk import Sdk
from peaq_sdk.types import ChainType

load_dotenv()

HTTPS_PEAQ_URL = os.getenv("HTTPS_PEAQ_URL")

sdk = Sdk.create_instance(
    base_url=HTTPS_PEAQ_URL,
    chain_type=ChainType.EVM
)

user_id = "9e8c7866-8435-4b76-8683-709a03c9"
group_id = "d07cd755-8f2f-497f-ad53-9d6cf828"

response = sdk.rbac.assign_user_to_group(user_id=user_id, group_id=group_id)

fetch_user_groups(owner, user_id)

Fetches all groups that a specific user is assigned to in the RBAC system.

ParameterTypeEVMSubstrateDescription
ownerstrRequiredRequiredAddress of the group owner.
user_idstrRequiredRequiredID of the user to fetch groups for (32 characters).

Fetch User Groups Code Examples

import os
from dotenv import load_dotenv
from peaq_sdk import Sdk
from peaq_sdk.types import ChainType

load_dotenv()

EVM_ADDRESS = os.getenv("EVM_ADDRESS")
HTTPS_PEAQ_URL = os.getenv("HTTPS_PEAQ_URL")
WSS_PEAQ_URL = os.getenv("WSS_PEAQ_URL")

sdk = Sdk.create_instance(
    base_url=HTTPS_PEAQ_URL,
    chain_type=ChainType.EVM
)

user_id = "9e8c7866-8435-4b76-8683-709a03c9"

response = sdk.rbac.fetch_user_groups(owner=EVM_ADDRESS, user_id=user_id)

unassign_user_to_group(user_id, group_id)

Removes a user from a group in the RBAC system. The user will lose all roles and permissions associated with the group.

ParameterTypeEVMSubstrateDescription
user_idstrRequiredRequiredID of the user to be unassigned from the group (32 characters).
group_idstrRequiredRequiredID of the group to unassign the user from (32 characters).

Unassign User to Group Code Examples

import os
from dotenv import load_dotenv
from peaq_sdk import Sdk
from peaq_sdk.types import ChainType

load_dotenv()

HTTPS_PEAQ_URL = os.getenv("HTTPS_PEAQ_URL")

sdk = Sdk.create_instance(
    base_url=HTTPS_PEAQ_URL,
    chain_type=ChainType.EVM
)

user_id = "9e8c7866-8435-4b76-8683-709a03c9"
group_id = "d07cd755-8f2f-497f-ad53-9d6cf828"

response = sdk.rbac.unassign_user_to_group(user_id=user_id, group_id=group_id)