[]
        
(Showing Draft Content)

Role

Role

[GET] /api/v1/roles

Get all roles.

Parameters

Name Type Located In
IncludePermissions Boolean query
IncludeMembers Boolean query
SearchType SearchType query

Response

Status Code: 200

Success

[POST] /api/v1/roles

Add a new role.

Request Schema

NewRoleModel

Response

Status Code: 200

Success

[GET] /api/v1/roles/non-org-roles

Get all the roles which do not belong to any organization.

Parameters

Name Type Located In
IncludePermissions Boolean query
IncludeMembers Boolean query
SearchType SearchType query

Response

Status Code: 200

Success

[GET] /api/v1/roles/non-tenant-roles

Get all the roles which do not belong to any organization.

Parameters

Name Type Located In
IncludePermissions Boolean query
IncludeMembers Boolean query
SearchType SearchType query

Response

Status Code: 200

Success

[GET] /api/v1/roles/me/non-org-roles

Get all the global roles of the current logged in user.

Parameters

Name Type Located In Description
all Boolean query Retrive all global roles, only take effect when the current logged in user is a system administrator.

Response

Status Code: 200

Success

[GET] /api/v1/roles/me/non-tenant-roles

Get all the global roles of the current logged in user.

Parameters

Name Type Located In Description
all Boolean query Retrive all global roles, only take effect when the current logged in user is a system administrator.

Response

Status Code: 200

Success

[GET] /api/v1/roles/{id}

Get role information by id.

Parameters

Name Type Located In Description
idRequired string path
includePermission Boolean query

Response

Status Code: 200

Success

[DELETE] /api/v1/roles/{id}

Delete an role.

Parameters

Name Type Located In Description
idRequired string path

Response

Status Code: 200

Success

[GET] /api/v1/roles/{id}/users

Get all users who belongs to the specified role.

Parameters

Name Type Located In Description
idRequired string path Role id.

Response

Status Code: 200

Success

[POST] /api/v1/roles/{id}/users

Add users to the specified role.

Parameters

Name Type Located In Description
idRequired string path

Request Schema

RoleUsersUpdateModel

Response

Status Code: 200

Success

[PUT] /api/v1/roles/{id}/users

Update the users who belongs to the giving role.

Parameters

Name Type Located In Description
idRequired string path

Request Schema

RoleUsersUpdateModel

Response

Status Code: 200

Success

[DELETE] /api/v1/roles/{id}/users/{userId}

Remove the user who belongs to the specified role.

Parameters

Name Type Located In Description
idRequired string path
userIdRequired string path

Response

Status Code: 200

Success

[GET] /api/v1/roles/{id}/permissions

Get the permissions of the specified role.

Parameters

Name Type Located In Description
idRequired string path

Response

Status Code: 200

Success

[POST] /api/v1/roles/{id}/permissions

Update the permissions of the giving role.

Parameters

Name Type Located In Description
idRequired string path

Request Schema

RolePermissionsUpdateModel

Response

Status Code: 200

Success

[POST] /api/v1/roles/import

Import roles.

Request Schema

RolesImportModel

Response

Status Code: 200

Success

Models

Ƭ SearchType

Enum:

  • None
  • Count

The search type for searching records.

Ƭ NewRoleModel

Name Type Description Example
nameNullable string

Ƭ RoleUsersUpdateModel

Name Type Description Example
userIdsNullable Array<string>

Ƭ RolePermissionsUpdateModel

Name Type Description Example
permissionsNullable Array<string>

Ƭ RolesImportModel

Name Type Description Example
rolesNullable RoleBizModel

Ƭ RoleBizModel

Name Type Description Example
idNullable string The unique identity of the role. "972B2A4C-8C61-4E3B-AD3D-6E889FE8D761"
nameNullable string The name of the role. "DataManager"
creatorIdNullable string The creator id of the role. "CF61388C-D7CD-4A61-8FB3-A8A0B6915F3E"
createTime ISO DateTime Sting The creation time of the role. "2000-01-01 00:00:00.000"
isBuiltin Boolean Whether it is a built-in role.
allowEditPermissions Boolean Whether allow to edit the permissions of the role. true
permissionsNullable Array<string> The permissions of the role. ["view-report","view-dashboard"]
membersNullable Array<string> The member id list of the role. ["CD079B35-4A56-4F42-845D-726B09E08EA9","EAAA677A-7B0A-4471-99F0-4C3F1D31738C"]
tenantIdNullable string The id of the organization to which the role belongs. "D6FD678D-45B5-4222-BA81-58BE2E578F91"