Versions Compared

Version Old Version 18 New Version Current
Changes made by

antoine hage

antoine hage

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

General Information

...

ServiceAPIMethodData ModelsWorkflowGroup
multitenant/tenantPOSTTenantN/ATenant

Description

This API adds a main (product) or sub (client) tenant record. If the added tenant is a subtenant, the main tenant id should be provided or it will be automatically taken from the external key provided in the request headers.Add tenant with optional application, key, and ext key

Input

...

Type: application/json
NameSourceMandatoryTypeSpecial FormatDescription
nameBodyYESStringN/ATenant Name
descriptionBodyYESStringN/ATenant Description
codeBodyNOStringN/ATenant Code
typeBodyYESString
"enum": ["product", "client"]
Tenant Type
tagBodyNOStringN/ATenant Tag
consoleBodyNOBooleanTrue or FalseTenant is Console or not.
mainTenantBody - extKeyNOStringN/AMain Tenant ID if the new Tenant is a subtenant
profileBodyNOObjectN/A
oauthBodyNOObjectCheck Nested Table BelowOAuth access delegations


NameMandatoryTypeSpecial FormatDescription
secretYESStringN/AString for secret of oauth
redirectURIYESStringN/AURI for redirection
grantsYESArrayArray of Strings
disabledYESInteger"enum": [0, 1]
typeYESInteger

"enum": [1, 2]


loginModeYESInteger"enum": ["urac", "oauth"]Login Technology & Method
pinNOObjectN/APin Configuration


applicationBodyNOObjectCheck Nested Table BelowTenant Application


NameMandatoryTypeSpecial FormatDescription
descriptionNoStringN/AApplication Description
productCodeYESStringN/AApplication Product Code
packageCodeYESStringN/AApplication Product Package
_TTLYESString"enum": ['6', '12', '24', '48', '72', '96', '120', '144', '168']
appKeyYESObject


Code Block
languagejs
titleappKey Object
"appKey": {
	"config": {},
	"extKey": {
		"label": %key_label%,
		"env": %environemnt_name%
		"expDate": %expiry_date%
		"device": %device_name%,
		"geo": %geo_location% 
	}
}


You can find details about config object under Tenant Key Configuration

Application Key configuration


...