View Source

General Information

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

Description

This API updates the internal key that matches the one sent in the request body and exists in the application record that has the appId that matches the one also sent in the request body and exists in the tenant that has the id that matches the one sent in the query.

Input

Type: application/json

Name	Source	Mandatory	Type	Special Format	Description
id	Query	YES	String	N/A	Tenant ID
appId	Body	YES	String	N/A	Application ID
key	Body	YES	String	N/A	Application Key
config	Body	YES	Object	N/A	Key Config

Output

Response

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

Valid Response

{ 
  result: true,
  data: 1	
}

Invalid Response

{
    "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
473	Unable to get the tenant application key
500	You cannot modify or delete a locked record
602	Model error: + %model_error%