Tenant

[GET] /api/v1/tenants

Parameters

Name	In	Type	Default
includeProps	query	boolean	false

Get all tenants' information.

Responses

[200] Success

[POST] /api/v1/tenants

Add a new tenant.

Request Body

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

TenantCreateModel

Responses

[200] Success

[GET] /api/v1/organizations

Parameters

Name	In	Type	Default
includeProps	query	boolean	false

Get all tenants' information.

Responses

[200] Success

[POST] /api/v1/organizations

Add a new tenant.

Request Body

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

TenantCreateModel

Responses

[200] Success

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

Parameters

Name	In	Type	Description
idRequired	path	string	Tenant id.

Get specified tenant's information.

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Modify the specified tenant's information.

Request Body

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

TenantUpdateModel

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Delete the specified tenant.

Responses

[200] Success

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

Parameters

Name	In	Type	Description
idRequired	path	string	Tenant id.

Get specified tenant's information.

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Modify the specified tenant's information.

Request Body

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

TenantUpdateModel

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Delete the specified tenant.

Responses

[200] Success

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

Parameters

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

Get specified tenants' information.

Responses

[200] Success

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

Parameters

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

Get specified tenants' information.

Responses

[200] Success

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

Parameters

Name	In	Type	Description	Default
idRequired	path	string	Tenant id.
includeSelf	query	boolean		false

Get all the sub-tenants of the specified tenant.

Responses

[200] Success

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

Parameters

Name	In	Type	Description	Default
idRequired	path	string	Tenant id.
includeSelf	query	boolean		false

Get all the sub-tenants of the specified tenant.

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Get all the ancestor tenants of the specified tenant.

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Get all the ancestor tenants of the specified tenant.

Responses

[200] Success

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

Parameters

Name	In	Type	Default
idRequired	path	string
includeSubTenantUsers	query	boolean	false

Get the users belong to the specified tenant.

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Add users to specified tenant.

Request Body

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

UserListModel

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Update the users belong to the specified tenant.

Request Body

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

UserListModel

Responses

[200] Success

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

Parameters

Name	In	Type	Default
idRequired	path	string
includeSubTenantUsers	query	boolean	false

Get the users belong to the specified tenant.

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Add users to specified tenant.

Request Body

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

UserListModel

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Update the users belong to the specified tenant.

Request Body

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

UserListModel

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
userIdRequired	path	string

Delete the specified user from the specified tenant.

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
userIdRequired	path	string

Delete the specified user from the specified tenant.

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Get the users do not belong to the specified tenant.

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Get the users do not belong to the specified tenant.

Responses

[200] Success

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

Parameters

Name	In	Type	Default
idRequired	path	string
includeSubTenantRoles	query	boolean	false

Get all the roles of the specified tenant.

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Add new role to the specified tenant.

Request Body

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

NewRoleModel

Responses

[200] Success

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

Parameters

Name	In	Type	Default
idRequired	path	string
includeSubTenantRoles	query	boolean	false

Get all the roles of the specified tenant.

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Add new role to the specified tenant.

Request Body

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

NewRoleModel

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
roleIdRequired	path	string

Get the specified tenant's role.

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
roleIdRequired	path	string

Delete the specified role from the specified tenant.

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
roleIdRequired	path	string

Get the specified tenant's role.

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
roleIdRequired	path	string

Delete the specified role from the specified tenant.

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
roleIdRequired	path	string

Get the users belong to the specified tenant role.

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
roleIdRequired	path	string

Add users to the specified tenant role.

Request Body

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

UserListModel

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
roleIdRequired	path	string

Update the users of the specified tenant role.

Request Body

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

UserListModel

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
roleIdRequired	path	string

Get the users belong to the specified tenant role.

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
roleIdRequired	path	string

Add users to the specified tenant role.

Request Body

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

UserListModel

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
roleIdRequired	path	string

Update the users of the specified tenant role.

Request Body

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

UserListModel

Responses

[200] Success

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

Parameters

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

Delete the users from the specified tenant role.

Responses

[200] Success

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

Parameters

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

Delete the users from the specified tenant role.

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
roleIdRequired	path	string

Get the permissions of the specified tenant role.

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
roleIdRequired	path	string

Update the permissions of the specified tenant role.

Request Body

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

PermissionListModel

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
roleIdRequired	path	string

Get the permissions of the specified tenant role.

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
roleIdRequired	path	string

Update the permissions of the specified tenant role.

Request Body

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

PermissionListModel

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Get the specified tenant's permissions.

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Update the specified tenant's permissions.

Request Body

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

PermissionListModel

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Get the specified tenant's permissions.

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Update the specified tenant's permissions.

Request Body

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

PermissionListModel

Responses

[200] Success

[GET] /api/v1/tenants/props

Parameters

Name	In	Type	Default
includeBuiltInProps	query	boolean	false

Get all tenant properties.

Responses

[200] Success

[POST] /api/v1/tenants/props

Add a new tenant property.

Request Body

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

TenantPropInfoModel

Responses

[200] Success

[GET] /api/v1/organizations/props

Parameters

Name	In	Type	Default
includeBuiltInProps	query	boolean	false

Get all tenant properties.

Responses

[200] Success

[POST] /api/v1/organizations/props

Add a new tenant property.

Request Body

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

TenantPropInfoModel

Responses

[200] Success

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

Parameters

Name	In	Type
orgPropIdRequired	path	string

Modify the specified tenant property.

Request Body

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

TenantPropInfoModel

Responses

[200] Success

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

Parameters

Name	In	Type
orgPropIdRequired	path	string

Delete the specified tenant property.

Responses

[200] Success

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

Parameters

Name	In	Type
orgPropIdRequired	path	string

Modify the specified tenant property.

Request Body

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

TenantPropInfoModel

Responses

[200] Success

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

Parameters

Name	In	Type
orgPropIdRequired	path	string

Delete the specified tenant property.

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Modify the order of the specified organization.

Request Body

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

MoveTenantModel

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Modify the order of the specified organization.

Request Body

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

MoveTenantModel

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Get all the settings of the specified organization.

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Get all the settings of the specified organization.

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
pluginKeyRequired	path	string

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

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
pluginKeyRequired	path	string

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

Request Body

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

UpdateTenantPluginSettingsModel

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
pluginKeyRequired	path	string

Delete the settings of the specified organization's plugin.

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
pluginKeyRequired	path	string

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

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
pluginKeyRequired	path	string

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

Request Body

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

UpdateTenantPluginSettingsModel

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
pluginKeyRequired	path	string

Delete the settings of the specified organization's plugin.

Responses

[200] Success

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

Parameters

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

Get the specified organization setting.

Responses

[200] Success

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

Parameters

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

Update the specified organization setting.

Request Body

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

UpdateTenantSettingModel

Responses

[200] Success

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

Parameters

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

Delete the specified organization setting.

Responses

[200] Success

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

Parameters

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

Get the specified organization setting.

Responses

[200] Success

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

Parameters

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

Update the specified organization setting.

Request Body

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

UpdateTenantSettingModel

Responses

[200] Success

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

Parameters

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

Delete the specified organization setting.

Responses

[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	Array<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"]
nameRequired	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	Array<TenantPropValueBizModel>	The tenant properties.

Ƭ UserListModel

Name	Type
userIdsNullable	Array<string>

Ƭ NewRoleModel

Name	Type
nameNullable	string

Ƭ PermissionListModel

Name	Type
permissionsNullable	Array<string>

Ƭ TenantPropInfoModel

Name	Type	Description	Example
nameRequired	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
offset	int32

Ƭ UpdateTenantPluginSettingsModel

Name	Type
settingsNullable	string

Ƭ UpdateTenantSettingModel

Name	Type
settingNullable	string