Update Tenant

Update Tenant is used to update the tenant, which was created using Create Tenant.

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

PUT https://{tenantId}.{hostname}/digitanium/v4/tenants/{tenantId}

OR

PUT https://{tenantId}.{hostname}/digitanium/v4/tenants/?tenantname=testrealm

HTTP request URL for SHIFT

PUT https://{hostname}/auth/realms/master/v3_realm/{tenantId}

note

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

Parameters

No parameter fields are required.

Request body

Field Name	Type	Description
realm	String	Define unique realm id.
enabled	String	If this is set to true the realm is enabled.
loginTheme	String	Define the theme of the realm.
accountTheme	String	Define the theme of the account.
adminTheme	String	Define the theme of the admin.
adminFirstName	String	Define Firstname of admin user.
adminLastName	String	Define Lastname of admin user.
bruteForceProtected	String	Bruteforce will be activated, if enabled.
otpBruteForceProtected	String	Bruteforce will be activated for otp brute force detection.
requiredActions	Boolean	Pre-requisite for the functionality required.
alias	String	Pre-requisite for the functionality required.
name	String	The name for the required action.
providerId	String	The required action’s Id.
enabled	Boolean	If this is true the required action is enabled.
Priority	Integer	The execution order of the required action.

Sample Request

{ 
    "realm": "tenantExt0019", 
    "enabled": true, 
    "loginTheme": "kobilv2", 
    "accountTheme": "kobilv2", 
    "adminTheme": "kobilv2", 
    "emailTheme": "kobilv2", 
    "adminEmail": "user123@gmail.com", 
    "adminFirstName": "", 
    "adminLastName": "", 
    "bruteForceProtected": true, 
    "otpBruteForceProtected": true, 
    "requiredActions":[ 
        { 
            "alias": "kobil-reg-status-required-action", 
            "name": "KOBIL Registration Status Verification", 
            "providerId": "kobil-reg-status-required-action", 
            "enabled": true, 
            "priority":1001 
        } 
    ] 
}

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 updated successfully",
    "status": "OK",
    "subSystem": 1
}

Response Status Information

Status Code	Status	Message
200	OK	Tenant updated successfully
401	Unauthorized	HTTP 401 Unauthorized
404	TENANT_NOT_FOUND	Tenant does not exist