Add Tenant Application Key

General Information

Service	API	Method	Data Models	Workflow
multitenant	/tenant/application/key	POST	Tenant	N/A

Description

This API adds an application key to the tenant that has external key send in the request headers. The application key will be added under the app that has the appId sent in the request body.

Input

Type: application/json

Name

Source

Mandatory

Type

Special Format

Description

appId

Body

YES

String

N/A

Application ID

config

Body

NO

Object

N/A

Key Configuration

extKey

Body

NO

Object

Application External Key

Name	Mandatory	Type	Special Format	Description
label	YES	Object	N/A	Key Configuration
env	YES	String	N/A	Environment
expDate	NO	String	date-time	Expiry Date
device	NO	Object	N/A	Device Config
geo	NO	Object	N/A	Geo Loacation

Tenant id will automatically be taken from the extKey provided (tenant logged in from).

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: true
}

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
450	Unable to find tenant
471	Unable to update tenant
472	Unable to get the tenant application
500	You cannot modify or delete a locked record
501	Environment record not found!
502	Unable to create External key
602	Model error: + %model_error%

Add Tenant Application Key

[data-colorid=ke0f67o4hc]{color:#091e42} html[data-color-mode=dark] [data-colorid=ke0f67o4hc]{color:#bdd2f6}General Information

Description

Input

Output

Response

Valid Response

Invalid Response

Response schema

SOAJS Error Codes

0 Comments

General Information