User Management Overview

Introduction

User Management includes several submodules: User, User Group, Role, User Group Member, and User Linked Account. Through User Management public APIs, you can:

Query users and user groups in the system

Create, modify, and delete users and user groups

Maintain relationships between users and user groups

Query and modify users' custom roles

Maintain users' external linked accounts

Corresponding Features

Corresponds to User Management in the BI Management Center. For details, refer to Help Center Documentation

Terminology

User

System users. User attributes include but are not limited to:

Account: The user's login account in BI, typically using loginId as the interface parameter.

Account Type: Each user has only one account type. Enum values include admin, editor, and participant, representing administrator, regular user, and read-only account respectively.

Belonging User Groups: A user can have multiple user groups

Custom Roles: Each user can have multiple custom roles. Users can have different RBAC permissions through custom roles.

User Group

User groups classify and categorize users, enabling enterprise administrators to manage various user permissions more directly and conveniently. User group attributes include but are not limited to:

User Group ID: The unique identifier of a user group in BI. Typically using ugId as the interface parameter.

External ID: When creating user groups via public API or account synchronization, each user group has a corresponding external ID. This represents the unique identifier of the user group in third-party systems. Typically using externalGroupId as the interface parameter.

Parent User Group: A user group can have one parent user group and multiple child user groups, forming a tree structure. The root user group's parent user group ID is empty.

Role: Users can inherit custom roles through user groups

Role

Roles are specific permission groups assigned to each account by administrators, with each role having corresponding functional permission information.

Account Types: Read-only user, regular user, and administrator.

System Roles: Mainly refers to group administrators. When the group administrator feature is enabled, you can view the list of group administrators here, and which user groups each group administrator can manage.

Custom Roles: Supports creating custom roles and assigning corresponding functional permissions as needed.

User Linked Account

In SSO, you can link BI accounts with accounts in the authentication system to enable SSO login for the linked BI accounts. Each user can configure one external account per SSO Provider. See Linked Account Configuration Introduction for details.

Introduction#

Corresponding Features#

Terminology#

User#

User Group#

Role#