Role

[GET] /api/v1/roles

Parameters

Name	In	Type
IncludePermissions	query	boolean
IncludeMembers	query	boolean
SearchType	query

Get all roles.

Responses

[200] Success

[POST] /api/v1/roles

Add a new role.

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

NewRoleModel

Responses

[200] Success

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

Parameters

Name	In	Type
IncludePermissions	query	boolean
IncludeMembers	query	boolean
SearchType	query

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

Responses

[200] Success

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

Parameters

Name	In	Type
IncludePermissions	query	boolean
IncludeMembers	query	boolean
SearchType	query

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

Responses

[200] Success

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

Parameters

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

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

Responses

[200] Success

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

Parameters

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

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

Responses

[200] Success

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

Parameters

Name	In	Type	Default
idRequired	path	string
includePermission	query	boolean	true

Get role information by id.

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Delete an role.

Responses

[200] Success

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

Parameters

Name	In	Type	Description
idRequired	path	string	Role id.

Get all users who belongs to the specified role.

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Add users to the specified role.

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

RoleUsersUpdateModel

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Update the users who belongs to the giving role.

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

RoleUsersUpdateModel

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
userIdRequired	path	string

Remove the user who belongs to the specified role.

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Get the permissions of the specified role.

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Update the permissions of the giving role.

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

RolePermissionsUpdateModel

Responses

[200] Success

[POST] /api/v1/roles/import

Import roles.

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

RolesImportModel

Responses

[200] Success

Models

Ƭ SearchType

Enum:

• None

• Count

  The search type for searching records.

Ƭ NewRoleModel

Name	Type
nameNullable	string

Ƭ RoleUsersUpdateModel

Name	Type
userIdsNullable	Array<string>

Ƭ RolePermissionsUpdateModel

Name	Type
permissionsNullable	Array<string>

Ƭ RolesImportModel

Name	Type
rolesNullable	Array<RoleBizModel>

Ƭ RoleBizModel

Name	Type	Description	Example
idNullable	string	The unique identity of the role.	"972B2A4C-8C61-4E3B-AD3D-6E889FE8D761"
nameNullable	string	The display 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.	false
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"
modifiedByNullable	string	The modifiedBy id of the role.	"CF61388C-D7CD-4A61-8FB3-A8A0B6915F3E"
modifiedTime	ISO DateTime Sting	The modified time of the role.	"2000-01-01 00:00:00.000"