[]
        
(Showing Draft Content)

Tenant

Tenant

[GET] /api/v1/tenants

Get all tenants' information.

Parameters

Name Type Located In
includeProps Boolean query

Response

Status Code: 200

Success

[POST] /api/v1/tenants

Add a new tenant.

Request Schema

TenantCreateModel

Response

Status Code: 200

Success

[GET] /api/v1/organizations

Get all tenants' information.

Parameters

Name Type Located In
includeProps Boolean query

Response

Status Code: 200

Success

[POST] /api/v1/organizations

Add a new tenant.

Request Schema

TenantCreateModel

Response

Status Code: 200

Success

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

Get specified tenant's information.

Parameters

Name Type Located In Description
idRequired string path Tenant id.

Response

Status Code: 200

Success

[PUT] /api/v1/tenants/{id}

Modify the specified tenant's information.

Parameters

Name Type Located In Description
idRequired string path

Request Schema

TenantUpdateModel

Response

Status Code: 200

Success

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

Delete the specified tenant.

Parameters

Name Type Located In Description
idRequired string path

Response

Status Code: 200

Success

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

Get specified tenant's information.

Parameters

Name Type Located In Description
idRequired string path Tenant id.

Response

Status Code: 200

Success

[PUT] /api/v1/organizations/{id}

Modify the specified tenant's information.

Parameters

Name Type Located In Description
idRequired string path

Request Schema

TenantUpdateModel

Response

Status Code: 200

Success

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

Delete the specified tenant.

Parameters

Name Type Located In Description
idRequired string path

Response

Status Code: 200

Success

[GET] /api/v1/tenants/{ids}/multiple

Get specified tenants' information.

Parameters

Name Type Located In Description
idsRequired string path Tenant id list. Comma splice.

Response

Status Code: 200

Success

[GET] /api/v1/organizations/{ids}/multiple

Get specified tenants' information.

Parameters

Name Type Located In Description
idsRequired string path Tenant id list. Comma splice.

Response

Status Code: 200

Success

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

Get all the sub-tenants of the specified tenant.

Parameters

Name Type Located In Description
idRequired string path Tenant id.
includeSelf Boolean query

Response

Status Code: 200

Success

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

Get all the sub-tenants of the specified tenant.

Parameters

Name Type Located In Description
idRequired string path Tenant id.
includeSelf Boolean query

Response

Status Code: 200

Success

[GET] /api/v1/organizations/{id}/ancestor-organizations

Get all the ancestor tenants of the specified tenant.

Parameters

Name Type Located In Description
idRequired string path

Response

Status Code: 200

Success

[GET] /api/v1/tenants/{id}/ancestor-tenants

Get all the ancestor tenants of the specified tenant.

Parameters

Name Type Located In Description
idRequired string path

Response

Status Code: 200

Success

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

Get the users belong to the specified tenant.

Parameters

Name Type Located In Description
idRequired string path
includeSubTenantUsers Boolean query

Response

Status Code: 200

Success

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

Add users to specified tenant.

Parameters

Name Type Located In Description
idRequired string path

Request Schema

UserListModel

Response

Status Code: 200

Success

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

Update the users belong to the specified tenant.

Parameters

Name Type Located In Description
idRequired string path

Request Schema

UserListModel

Response

Status Code: 200

Success

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

Get the users belong to the specified tenant.

Parameters

Name Type Located In Description
idRequired string path
includeSubTenantUsers Boolean query

Response

Status Code: 200

Success

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

Add users to specified tenant.

Parameters

Name Type Located In Description
idRequired string path

Request Schema

UserListModel

Response

Status Code: 200

Success

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

Update the users belong to the specified tenant.

Parameters

Name Type Located In Description
idRequired string path

Request Schema

UserListModel

Response

Status Code: 200

Success

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

Delete the specified user from the specified tenant.

Parameters

Name Type Located In Description
idRequired string path
userIdRequired string path

Response

Status Code: 200

Success

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

Delete the specified user from the specified tenant.

Parameters

Name Type Located In Description
idRequired string path
userIdRequired string path

Response

Status Code: 200

Success

[GET] /api/v1/organizations/{id}/non-org-users

Get the users do not belong to the specified tenant.

Parameters

Name Type Located In
idRequired string path

Response

Status Code: 200

Success

[GET] /api/v1/tenants/{id}/non-tenant-users

Get the users do not belong to the specified tenant.

Parameters

Name Type Located In
idRequired string path

Response

Status Code: 200

Success

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

Get all the roles of the specified tenant.

Parameters

Name Type Located In Description
idRequired string path
includeSubTenantRoles Boolean query

Response

Status Code: 200

Success

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

Add new role to the specified tenant.

Parameters

Name Type Located In Description
idRequired string path

Request Schema

NewRoleModel

Response

Status Code: 200

Success

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

Get all the roles of the specified tenant.

Parameters

Name Type Located In Description
idRequired string path
includeSubTenantRoles Boolean query

Response

Status Code: 200

Success

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

Add new role to the specified tenant.

Parameters

Name Type Located In Description
idRequired string path

Request Schema

NewRoleModel

Response

Status Code: 200

Success

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

Get the specified tenant's role.

Parameters

Name Type Located In Description
idRequired string path
roleIdRequired string path

Response

Status Code: 200

Success

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

Delete the specified role from the specified tenant.

Parameters

Name Type Located In Description
idRequired string path
roleIdRequired string path

Response

Status Code: 200

Success

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

Get the specified tenant's role.

Parameters

Name Type Located In Description
idRequired string path
roleIdRequired string path

Response

Status Code: 200

Success

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

Delete the specified role from the specified tenant.

Parameters

Name Type Located In Description
idRequired string path
roleIdRequired string path

Response

Status Code: 200

Success

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

Get the users belong to the specified tenant role.

Parameters

Name Type Located In Description
idRequired string path
roleIdRequired string path

Response

Status Code: 200

Success

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

Add users to the specified tenant role.

Parameters

Name Type Located In Description
idRequired string path
roleIdRequired string path

Request Schema

UserListModel

Response

Status Code: 200

Success

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

Update the users of the specified tenant role.

Parameters

Name Type Located In Description
idRequired string path
roleIdRequired string path

Request Schema

UserListModel

Response

Status Code: 200

Success

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

Get the users belong to the specified tenant role.

Parameters

Name Type Located In Description
idRequired string path
roleIdRequired string path

Response

Status Code: 200

Success

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

Add users to the specified tenant role.

Parameters

Name Type Located In Description
idRequired string path
roleIdRequired string path

Request Schema

UserListModel

Response

Status Code: 200

Success

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

Update the users of the specified tenant role.

Parameters

Name Type Located In Description
idRequired string path
roleIdRequired string path

Request Schema

UserListModel

Response

Status Code: 200

Success

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

Delete the users from the specified tenant role.

Parameters

Name Type Located In Description
idRequired string path
roleIdRequired string path
userIdRequired string path

Response

Status Code: 200

Success

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

Delete the users from the specified tenant role.

Parameters

Name Type Located In Description
idRequired string path
roleIdRequired string path
userIdRequired string path

Response

Status Code: 200

Success

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

Get the permissions of the specified tenant role.

Parameters

Name Type Located In Description
idRequired string path
roleIdRequired string path

Response

Status Code: 200

Success

[PUT] /api/v1/tenants/{id}/roles/{roleId}/permissions

Update the permissions of the specified tenant role.

Parameters

Name Type Located In Description
idRequired string path
roleIdRequired string path

Request Schema

PermissionListModel

Response

Status Code: 200

Success

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

Get the permissions of the specified tenant role.

Parameters

Name Type Located In Description
idRequired string path
roleIdRequired string path

Response

Status Code: 200

Success

[PUT] /api/v1/organizations/{id}/roles/{roleId}/permissions

Update the permissions of the specified tenant role.

Parameters

Name Type Located In Description
idRequired string path
roleIdRequired string path

Request Schema

PermissionListModel

Response

Status Code: 200

Success

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

Get the specified tenant's permissions.

Parameters

Name Type Located In Description
idRequired string path

Response

Status Code: 200

Success

[PUT] /api/v1/tenants/{id}/permissions

Update the specified tenant's permissions.

Parameters

Name Type Located In Description
idRequired string path

Request Schema

PermissionListModel

Response

Status Code: 200

Success

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

Get the specified tenant's permissions.

Parameters

Name Type Located In Description
idRequired string path

Response

Status Code: 200

Success

[PUT] /api/v1/organizations/{id}/permissions

Update the specified tenant's permissions.

Parameters

Name Type Located In Description
idRequired string path

Request Schema

PermissionListModel

Response

Status Code: 200

Success

[GET] /api/v1/tenants/props

Get all tenant properties.

Parameters

Name Type Located In
includeBuiltInProps Boolean query

Response

Status Code: 200

Success

[POST] /api/v1/tenants/props

Add a new tenant property.

Request Schema

TenantPropInfoModel

Response

Status Code: 200

Success

[GET] /api/v1/organizations/props

Get all tenant properties.

Parameters

Name Type Located In
includeBuiltInProps Boolean query

Response

Status Code: 200

Success

[POST] /api/v1/organizations/props

Add a new tenant property.

Request Schema

TenantPropInfoModel

Response

Status Code: 200

Success

[PUT] /api/v1/tenants/props/{orgPropId}

Modify the specified tenant property.

Parameters

Name Type Located In Description
orgPropIdRequired string path

Request Schema

TenantPropInfoModel

Response

Status Code: 200

Success

[DELETE] /api/v1/tenants/props/{orgPropId}

Delete the specified tenant property.

Parameters

Name Type Located In Description
orgPropIdRequired string path

Response

Status Code: 200

Success

[PUT] /api/v1/organizations/props/{orgPropId}

Modify the specified tenant property.

Parameters

Name Type Located In Description
orgPropIdRequired string path

Request Schema

TenantPropInfoModel

Response

Status Code: 200

Success

[DELETE] /api/v1/organizations/props/{orgPropId}

Delete the specified tenant property.

Parameters

Name Type Located In Description
orgPropIdRequired string path

Response

Status Code: 200

Success

[POST] /api/v1/tenants/{id}/move

Modify the order of the specified organization.

Parameters

Name Type Located In Description
idRequired string path

Request Schema

MoveTenantModel

Response

Status Code: 200

Success

[POST] /api/v1/organizations/{id}/move

Modify the order of the specified organization.

Parameters

Name Type Located In Description
idRequired string path

Request Schema

MoveTenantModel

Response

Status Code: 200

Success

[GET] /api/v1/tenants/{id}/settings

Get all the settings of the specified organization.

Parameters

Name Type Located In Description
idRequired string path

Response

Status Code: 200

Success

[GET] /api/v1/organizations/{id}/settings

Get all the settings of the specified organization.

Parameters

Name Type Located In Description
idRequired string path

Response

Status Code: 200

Success

[GET] /api/v1/tenants/{id}/settings/{pluginKey}

Get the specified plugin's settings of the specified organization.

Parameters

Name Type Located In Description
idRequired string path
pluginKeyRequired string path

Response

Status Code: 200

Success

[PUT] /api/v1/tenants/{id}/settings/{pluginKey}

Update the specified settings of the specified organization's plugin.

Parameters

Name Type Located In Description
idRequired string path
pluginKeyRequired string path

Request Schema

UpdateTenantPluginSettingsModel

Response

Status Code: 200

Success

[DELETE] /api/v1/tenants/{id}/settings/{pluginKey}

Delete the settings of the specified organization's plugin.

Parameters

Name Type Located In Description
idRequired string path
pluginKeyRequired string path

Response

Status Code: 200

Success

[GET] /api/v1/organizations/{id}/settings/{pluginKey}

Get the specified plugin's settings of the specified organization.

Parameters

Name Type Located In Description
idRequired string path
pluginKeyRequired string path

Response

Status Code: 200

Success

[PUT] /api/v1/organizations/{id}/settings/{pluginKey}

Update the specified settings of the specified organization's plugin.

Parameters

Name Type Located In Description
idRequired string path
pluginKeyRequired string path

Request Schema

UpdateTenantPluginSettingsModel

Response

Status Code: 200

Success

[DELETE] /api/v1/organizations/{id}/settings/{pluginKey}

Delete the settings of the specified organization's plugin.

Parameters

Name Type Located In Description
idRequired string path
pluginKeyRequired string path

Response

Status Code: 200

Success

[GET] /api/v1/tenants/{id}/settings/{pluginKey}/{groupKey}

Get the specified organization setting.

Parameters

Name Type Located In Description
idRequired string path
pluginKeyRequired string path
groupKeyRequired string path

Response

Status Code: 200

Success

[PUT] /api/v1/tenants/{id}/settings/{pluginKey}/{groupKey}

Update the specified organization setting.

Parameters

Name Type Located In Description
idRequired string path
pluginKeyRequired string path
groupKeyRequired string path

Request Schema

UpdateTenantSettingModel

Response

Status Code: 200

Success

[DELETE] /api/v1/tenants/{id}/settings/{pluginKey}/{groupKey}

Delete the specified organization setting.

Parameters

Name Type Located In Description
idRequired string path
pluginKeyRequired string path
groupKeyRequired string path

Response

Status Code: 200

Success

[GET] /api/v1/organizations/{id}/settings/{pluginKey}/{groupKey}

Get the specified organization setting.

Parameters

Name Type Located In Description
idRequired string path
pluginKeyRequired string path
groupKeyRequired string path

Response

Status Code: 200

Success

[PUT] /api/v1/organizations/{id}/settings/{pluginKey}/{groupKey}

Update the specified organization setting.

Parameters

Name Type Located In Description
idRequired string path
pluginKeyRequired string path
groupKeyRequired string path

Request Schema

UpdateTenantSettingModel

Response

Status Code: 200

Success

[DELETE] /api/v1/organizations/{id}/settings/{pluginKey}/{groupKey}

Delete the specified organization setting.

Parameters

Name Type Located In Description
idRequired string path
pluginKeyRequired string path
groupKeyRequired string path

Response

Status Code: 200

Success

Models

Ƭ TenantCreateModel

Name Type Description Example
parentTenantIdNullable string The parent organization id, null means to create a organization under the "Global" organization. "3FEF2BB9-4D25-47AA-8196-928CEC86A7C6"
nameNullable string The organization name. "GrapeCity"
descriptionNullable string The description text of the organization. "This is a sample organization."
propsNullable TenantPropValueBizModel The tenant properties.

Ƭ TenantPropValueBizModel

Name Type Description Example
idNullable string The unique identity of the organization property value. "393B6B48-4C8B-4B0F-9175-A01177CBD328"
allowSubTenantEditing Boolean Whether allow the sub-organizations to edit this property value. true
editable Boolean Whether the property value is editable. true
allowSubTenantViewing Boolean Whether allow the sub-organizations to view this property value. true
viewable Boolean Whether the property value is viewable. true
valuesNullable Array<string> The property values. ["value1","value2","value3"]
name string The organization property name. "OrganizationAddress"
descriptionNullable string The description text of the organization property. "The address of the organization."
required Boolean Whether the property is required. true
valueType PropertyValueType
multivalued Boolean Whether the property can have multiple values. true
sensitive Boolean Whether the property is sensitive.

Ƭ PropertyValueType

Enum:

  • Text
  • Boolean
  • Integer
  • Float
  • Date
  • DateTime

The value type of the organization property.

Ƭ TenantUpdateModel

Name Type Description Example
nameNullable string The organization name. "GrapeCity"
descriptionNullable string The description text of the organization. "This is a sample organization."
propsNullable TenantPropValueBizModel The tenant properties.

Ƭ UserListModel

Name Type Description Example
userIdsNullable Array<string>

Ƭ NewRoleModel

Name Type Description Example
nameNullable string

Ƭ PermissionListModel

Name Type Description Example
permissionsNullable Array<string>

Ƭ TenantPropInfoModel

Name Type Description Example
name string The organization property name. "OrganizationAddress"
descriptionNullable string The description text of the organization property. "The address of the organization."
required Boolean Whether the property is required. true
valueType PropertyValueType
multivalued Boolean Whether the property can have multiple values. true
sensitive Boolean Whether the property is sensitive.

Ƭ MoveTenantModel

Name Type Description Example
offset int32

Ƭ UpdateTenantPluginSettingsModel

Name Type Description Example
settingsNullable string

Ƭ UpdateTenantSettingModel

Name Type Description Example
settingNullable string