Tenant

[GET] /api/v1/tenants

Get all the tenants.

Parameters

Name	Type	Located In	Description
includeProps	Boolean	query	The tenant properties.

Response

Status Code: 200

Success

[POST] /api/v1/tenants

Create a new tenant.

Request Schema

TenantCreateModel

Response

Status Code: 200

Success

[GET] /api/v1/organizations

Get all the organizations.

Parameters

Name	Type	Located In	Description
includeProps	Boolean	query	The organization properties.

Response

Status Code: 200

Success

[POST] /api/v1/organizations

Create a new organization.

Request Schema

TenantCreateModel

Response

Status Code: 200

Success

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

Get the specified tenant's information.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The tenant id.

Response

Status Code: 200

Success

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

Update the specified tenant.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The tenant id.

Request Schema

TenantUpdateModel

Response

Status Code: 200

Success

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

Delete a specified tenant.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The tenant id.

Response

Status Code: 200

Success

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

Get the specified organization's information.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The organization id.

Response

Status Code: 200

Success

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

Update the specified organization.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The organization id.

Request Schema

TenantUpdateModel

Response

Status Code: 200

Success

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

Delete a specified organization.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The organization id.

Response

Status Code: 200

Success

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

Get the specified tenants' information.

Parameters

Name	Type	Located In	Description
idsRequired	string	path	The tenant ids.

Response

Status Code: 200

Success

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

Get the specified organizations' information.

Parameters

Name	Type	Located In	Description
idsRequired	string	path	The organization ids.

Response

Status Code: 200

Success

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

Get the sub-organizations' information of the specified organization.

Parameters

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

Response

Status Code: 200

Success

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

Get the sub-tenants' information of the specified tenant.

Parameters

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

Response

Status Code: 200

Success

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

Get the ancestor organizations' information of the specified organization.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The organization id.

Response

Status Code: 200

Success

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

Get the ancestor tenants' information of the specified tenant.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The tenant id.

Response

Status Code: 200

Success

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

Get all the users assigned to the specified tenant.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The tenant id.
includeSubTenantUsers	Boolean	query	Include the sub-tenant users.

Response

Status Code: 200

Success

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

Add assigned users to the specified tenant.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The tenant id.

Request Schema

UserListModel

Response

Status Code: 200

Success

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

Update the users assigned to the specified tenant.

Parameters

Name	Type	Located In
idRequired	string	path

Request Schema

UserListModel

Response

Status Code: 200

Success

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

Get the users list of the specified organization.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The organization id.
includeSubTenantUsers	Boolean	query	Include the sub-tenant users.

Response

Status Code: 200

Success

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

Add a new user to the specified organization's users list.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The organization id.

Request Schema

UserListModel

Response

Status Code: 200

Success

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

Update the specified organization's users list.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The organization id.

Request Schema

UserListModel

Response

Status Code: 200

Success

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

Remove the specified user from the specified tenant's users list.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The tenant id.
userIdRequired	string	path	The user id.

Response

Status Code: 200

Success

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

Remove the specified user from the specified organization's users list.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The organization id.
userIdRequired	string	path	The user id.

Response

Status Code: 200

Success

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

Get the users do not belong to the specified organization.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The organization id.

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	Description
idRequired	string	path	The tenant id.

Response

Status Code: 200

Success

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

Get the roles belong to the specified tenant.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The tenant id.
includeSubTenantRoles	Boolean	query	Include the sub-tenant roles.

Response

Status Code: 200

Success

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

Add a new role to the specified tenant.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The tenant id.

Request Schema

NewRoleModel

Response

Status Code: 200

Success

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

Get the roles belong to the specified organization.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The organization id.
includeSubTenantRoles	Boolean	query	Include the sub-tenant roles.

Response

Status Code: 200

Success

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

Add a new role to the specified organization.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The organization id.

Request Schema

NewRoleModel

Response

Status Code: 200

Success

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

Get the specified role's information belonging to a tenant.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The tenant id.
roleIdRequired	string	path	The role id.

Response

Status Code: 200

Success

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

Delete the specified role from the a tenant.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The tenant id.
roleIdRequired	string	path	The role id.

Response

Status Code: 200

Success

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

Get the specified role's information belonging to a particular organization.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The organization id.
roleIdRequired	string	path	The role id.

Response

Status Code: 200

Success

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

Delete the specified role of a particular organization.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The organization id.
roleIdRequired	string	path	The role id.

Response

Status Code: 200

Success

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

Get the users belonging to a specified role in a tenant.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The tenant id.
roleIdRequired	string	path	The role id.

Response

Status Code: 200

Success

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

Add a new role to the specified role in a tenant.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The tenant id.
roleIdRequired	string	path	The role id.

Request Schema

UserListModel

Response

Status Code: 200

Success

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

Update the users list of the specified role in a tenant.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The tenant id.
roleIdRequired	string	path	The role id.

Request Schema

UserListModel

Response

Status Code: 200

Success

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

Get the users belonging to the specified role in an organization.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The organization id.
roleIdRequired	string	path	The role id.

Response

Status Code: 200

Success

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

Add a new user to the specified role in an organization.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The organization id.
roleIdRequired	string	path	The role id.

Request Schema

UserListModel

Response

Status Code: 200

Success

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

Update the users list of the specified role in an organization.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The organization id.
roleIdRequired	string	path	The role id.

Request Schema

UserListModel

Response

Status Code: 200

Success

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

Delete the specified user from the specified role in a tenant.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The tenant id.
roleIdRequired	string	path	The role id.
userIdRequired	string	path	The user id.

Response

Status Code: 200

Success

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

Delete the specified user from the specified role in a tenant.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The tenant id.
roleIdRequired	string	path	The role id.
userIdRequired	string	path	The user id.

Response

Status Code: 200

Success

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

Get the permissions of the specified role in a tenant.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The tenant id.
roleIdRequired	string	path	The role id.

Response

Status Code: 200

Success

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

Update the permissions of the specified role in a tenant.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The tenant id.
roleIdRequired	string	path	The role id.

Request Schema

PermissionListModel

Response

Status Code: 200

Success

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

Get the permissions of the specified role in an organization.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The organization id.
roleIdRequired	string	path	The role id.

Response

Status Code: 200

Success

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

Update the permissions of the specified role in an organization.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The organization id.
roleIdRequired	string	path	The role id.

Request Schema

PermissionListModel

Response

Status Code: 200

Success

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

Get the permissions of the specified tenant.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The tenant id.

Response

Status Code: 200

Success

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

Update the permissions of the specified tenant.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The tenant id.

Request Schema

PermissionListModel

Response

Status Code: 200

Success

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

Get the permissions of the specified organization.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The organization id.

Response

Status Code: 200

Success

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

Update the permissions of the specified organization.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The organization id.

Request Schema

PermissionListModel

Response

Status Code: 200

Success

[GET] /api/v1/tenants/props

Get all the properties of tenant.

Parameters

Name	Type	Located In	Description
includeBuiltInProps	Boolean	query	The built-in properties of tenant.

Response

Status Code: 200

Success

[POST] /api/v1/tenants/props

Add a new property of tenant.

Request Schema

TenantPropInfoModel

Response

Status Code: 200

Success

[GET] /api/v1/organizations/props

Get the organization properties.

Parameters

Name	Type	Located In	Description
includeBuiltInProps	Boolean	query	The built-in properties of an organization.

Response

Status Code: 200

Success

[POST] /api/v1/organizations/props

Add a new organization property.

Request Schema

TenantPropInfoModel

Response

Status Code: 200

Success

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

Update the specified property for a tenant.

Parameters

Name	Type	Located In	Description
orgPropIdRequired	string	path	The organizationproperty id.

Request Schema

TenantPropInfoModel

Response

Status Code: 200

Success

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

Delete the specified organization property.

Parameters

Name	Type	Located In	Description
orgPropIdRequired	string	path	The organizationproperty id.

Response

Status Code: 200

Success

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

Update the specified organization property.

Parameters

Name	Type	Located In	Description
orgPropIdRequired	string	path	The organizationproperty id.

Request Schema

TenantPropInfoModel

Response

Status Code: 200

Success

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

Delete the specified organization property.

Parameters

Name	Type	Located In	Description
orgPropIdRequired	string	path	The organization property id.

Response

Status Code: 200

Success

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

Move the position of the specified tenant.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The tenant id.

Request Schema

MoveTenantModel

Response

Status Code: 200

Success

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

Move the position of the specified organization.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The organization id.

Request Schema

MoveTenantModel

Response

Status Code: 200

Success

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

Get the settings of the specified tenant.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The tenant id.

Response

Status Code: 200

Success

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

Get the settings of the specified organization.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The organization id.

Response

Status Code: 200

Success

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

Parameters

Name	Type	Located In	Description
idRequired	string	path
pluginKeyRequired	string	path

Response

Status Code: 200

Success

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

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}

Parameters

Name	Type	Located In	Description
idRequired	string	path
pluginKeyRequired	string	path

Response

Status Code: 200

Success

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

Parameters

Name	Type	Located In	Description
idRequired	string	path
pluginKeyRequired	string	path

Response

Status Code: 200

Success

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

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}

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}

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}

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}

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}

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}

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}

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
nameNullable	string
descriptionNullable	string
propsNullable	TenantPropValueBizModel

Ƭ TenantPropValueBizModel

Name	Type	Description	Example
idNullable	string
allowSubTenantEditing	Boolean
editable	Boolean
allowSubTenantViewing	Boolean
viewable	Boolean
valuesNullable	Array<string>
nameNullable	string
descriptionNullable	string
required	Boolean
valueType	TenantPropValueType
multivalued	Boolean

Ƭ TenantPropValueType

Enum:

• Text
• Boolean
• Number
• Password

Ƭ TenantUpdateModel

Name	Type	Description	Example
nameNullable	string
descriptionNullable	string
propsNullable	TenantPropValueBizModel

Ƭ 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
nameNullable	string
descriptionNullable	string
required	Boolean
valueType	TenantPropValueType
multivalued	Boolean

Ƭ MoveTenantModel

Name	Type	Description	Example
offset	int32

Ƭ UpdateTenantPluginSettingsModel

Name	Type	Description	Example
settingsNullable	string

Ƭ UpdateTenantSettingModel

Name	Type	Description	Example
settingNullable	string