Add Tenant

General Information

Service	API	Method	Data Models	Workflow
multitenancy	/tenants	POST	Tenant	N/A

Input

Type: application/json

Name

Source

Mandatory

Type

Special Format

Description

name

Body

YES

String

N/A

Tenant Name

description

Body

YES

String

N/A

Tenant Description

code

Body

NO

String

N/A

Tenant Code

type

Body

NO

String

"enum": ["product", "client"]

Tenant Type

tag

Body

NO

String

N/A

Tenant Tag

console

Body

NO

Boolean

True or False

Tenant is Console or not.

mainTenant

Body

NO

String

N/A

Name of Main Tenant if the new Tenant is a subtenant

profile

Body

NO

Object

N/A

oauth

Body

NO

Object

Check Nested Table Below

OAuth access delegations

Name	Mandatory	Type	Special Format	Description
secret	YES	String	N/A	String for secret of oauth
redirectURI	YES	String	N/A	URL for redirection
grants	YES	Array	Array of Strings
disabled	YES	Integer	"enum": [0, 1]	Tenant Code
type	YES	Integer	"enum": [1, 2]	Tenant Type
loginMode	YES	Integer	"enum": ["urac", "oauth"]	Login Technology

application

Body

NO

Object

Check Nested Table Below

Tenant Application

Name	Mandatory	Type	Special Format	Description
description	No	String	N/A	Application Description
productCode	YES	String	N/A	Application Product Code
productPackage	YES	String	N/A	Application Product Package
_TTL	YES	String	"enum": ['6', '12', '24', '48', '72', '96', '120', '144', '168']
appKey	NO	Object	appKey Object "key": { "key": %KEY%, "config": {} }	Application Key
extKey	YES	Object	Key Object "key": { "label": %key_label%, "env": %environment_name%, "expDate": %expiry_date%, "device": %device_name%, "geo": %geo_location% }	External Key

Output

Response

SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response

Valid Response

Valid Response Sample

{ 
  result: true,
  data:
   [ 
	 { 
	   _id: '5d7fa308d5ee5a3d2ca439da',
       oauth: {
			secret: "%secret%",
			redirectURI: "http://domain.com",
			grants: [
				"password",
				"refresh_token"
			],
			disabled: 0,
			type: 2.0,
			loginMode: "urac"
       },
       code: 'test',
       name: 'Test Tenant',
       description: 'this is a description for test tenant',
       applications: [Array] 
	 } 
   ] 
}

Invalid Response

Error Response Sample

{
    "result":false,
    "errors":{
        "codes":[602],
        "details":[
            {
                "code":602,
                "message":"Model error: + %model_error%"
            }
        ]
    }
}

Response schema

Follow this link to check out the response JSON Schema

SOAJS Error Codes

Code	Description
400	Business logic required data are missing
602	Model error: + %model_error%

Add Tenant

General Information

Input

Output

Response

Valid Response

Invalid Response

Response schema

SOAJS Error Codes

0 Comments