Update Tenant Settings

Using this API, we can add/update the realm settings.

Resource Informations

Name	Value
Requires authentication?	Yes
Rate limited?	No

Request

Request headers

Key	Value
Authorization	Bearer token
Content-Type	application/json

HTTP request URL for SSMS

POST https://{tenantId}.{hostname}/digitanium/v4/tenants/settings

HTTP request URL for SHIFT

POST https://{hostname}/auth/realms/{tenantId}/v3_realm/settings

note

API requests must be made over https. Calls made over plain http will fail.

Parameters

No parameter fields are required.

Request body(Required)

Field Name	Type	Description
Key (Required)	String	Provide a name of the "key" needs to be added.
Value (Required)	String	Provide a name of the "Value" needs to be added/updated.

Sample Request

{
	"key": "value"
}

Response

Field Name	Type	Description
message	String	Message explains result of the API call. Refer Response status Information for details.
status	String	The status of the API call. Refer Response status Information for details.
subSystem	Integer	subSystem categorizes the type of API that has been called. Refer Subsystem details for details.

Sample Response

{
    "message": "Tenant settings updated successfully",
    "status": "OK",
    "subSystem": 1
}

Response Status Information

Status Code	Status	Message
200	OK	Tenant settings updated successfully
400	BAD_REQUEST	Failed to create tenant
401	Unauthorized	HTTP 401 Unauthorized