Get Tenant Info

Get Tenant Info API is used to get the details about the 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

GET https://master.{hostname}/digitanium/v4/tenants/{tenantname}

HTTP request URL for SHIFT

GET https://{hostname}/auth/realms/master/v4_realm/{tenantname}

note

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

Parameters

No parameters fields are required.

Request body

No request body fields are required.

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.
data	Object	The tenant info object. Refer Data Representation
name	String	Tenant name.
enabled	Boolean	Indicates whether the tenant is enabled or not.
rememberMe	Boolean	If true allows user to remain logged in until session expires.
resetPassword	Boolean	If true reset password option in login screen is enabled for the tenant.
registrationAllowed	Boolean	If true user registration option in login screen is enabled for the tenant.
userCount	Boolean	the number of users.

Data Representation

Field Name	Type	Description
adminUsername	String	Default admin user.
createdTimeOfTheUser	String	Timestamp of the tenant created.

Sample Response

{ 
    "message": "Tenant info fetched successfully", 
    "status": "OK", 
    "subSystem": 1, 
    "data": { 
        "id": "tenantExt0019", 
        "realm": "tenantExt0019", 
        "notBefore": 0, 
        "defaultSignatureAlgorithm": "RS256", 
        "revokeRefreshToken": false, 
        "refreshTokenMaxReuse": 0, 
        "accessTokenLifespan": 300, 
        "accessTokenLifespanForImplicitFlow": 900, 
        "ssoSessionIdleTimeout": 1800, 
        "ssoSessionMaxLifespan": 36000, 
        "ssoSessionIdleTimeoutRememberMe": 0, 
        "ssoSessionMaxLifespanRememberMe": 0, 
        "offlineSessionIdleTimeout": 2592000, 
        "offlineSessionMaxLifespanEnabled": false, 
        "offlineSessionMaxLifespan": 5184000, 
        "clientSessionIdleTimeout": 0, 
        "clientSessionMaxLifespan": 0, 
        "clientOfflineSessionIdleTimeout": 0, 
        "clientOfflineSessionMaxLifespan": 0, 
        "accessCodeLifespan": 60, 
        "accessCodeLifespanUserAction": 300, 
        "accessCodeLifespanLogin": 1800, 
        "actionTokenGeneratedByAdminLifespan": 43200, 
        "actionTokenGeneratedByUserLifespan": 300, 
        "oauth2DeviceCodeLifespan": 600, 
        "oauth2DevicePollingInterval": 5, 
        "enabled": true, 
        "sslRequired": "external", 
        "registrationAllowed": false, 
        "registrationEmailAsUsername": false, 
        "rememberMe": false, 
        "verifyEmail": false, 
        "loginWithEmailAllowed": true, 
        "duplicateEmailsAllowed": false, 
        "resetPasswordAllowed": false, 
        "editUsernameAllowed": false, 
        "bruteForceProtected": true, 
        "permanentLockout": false, 
        "maxFailureWaitSeconds": 900, 
        "minimumQuickLoginWaitSeconds": 60, 
        "waitIncrementSeconds": 60, 
        "quickLoginCheckMilliSeconds": 1000, 
        "maxDeltaTimeSeconds": 43200, 
        "failureFactor": 30, 
        "otpBruteForceProtected": true, 
        "otpWaitIncrementSeconds": 0, 
        "otpFailureFactor": 0, 
        "otpMaxDeltaTimeSeconds": 0, 
        "smsServer": {}, 
        "settings": { 
            "test_mode": "true" 
        }, 
        "type": "AST", 
        "defaultRole": { 
            "id": "ce0e947c-579e-4a1a-877e-038cdaa3e28d", 
            "name": "default-roles-tenantext0019", 
            "description": "${role_default-roles}", 
            "composite": true, 
            "clientRole": false, 
            "containerId": "tenantExt0019" 
        }, 
        "requiredCredentials": [ 
            "password" 
        ], 
        "otpPolicyType": "totp", 
        "otpPolicyAlgorithm": "HmacSHA1", 
        "otpPolicyInitialCounter": 0, 
        "otpPolicyDigits": 6, 
        "otpPolicyLookAheadWindow": 1, 
        "otpPolicyPeriod": 30, 
        "otpSupportedApplications": [ 
            "FreeOTP", 
            "Google Authenticator" 
        ], 
        "webAuthnPolicyRpEntityName": "keycloak", 
        "webAuthnPolicySignatureAlgorithms": [ 
            "ES256" 
        ], 
        "webAuthnPolicyRpId": "", 
        "webAuthnPolicyAttestationConveyancePreference": "not specified", 
        "webAuthnPolicyAuthenticatorAttachment": "not specified", 
        "webAuthnPolicyRequireResidentKey": "not specified", 
        "webAuthnPolicyUserVerificationRequirement": "not specified", 
        "webAuthnPolicyCreateTimeout": 0, 
        "webAuthnPolicyAvoidSameAuthenticatorRegister": false, 
        "webAuthnPolicyAcceptableAaguids": [], 
        "webAuthnPolicyPasswordlessRpEntityName": "keycloak", 
        "webAuthnPolicyPasswordlessSignatureAlgorithms": [ 
            "ES256" 
        ], 
        "webAuthnPolicyPasswordlessRpId": "", 
        "webAuthnPolicyPasswordlessAttestationConveyancePreference": "not specified", 
        "webAuthnPolicyPasswordlessAuthenticatorAttachment": "not specified", 
        "webAuthnPolicyPasswordlessRequireResidentKey": "not specified", 
        "webAuthnPolicyPasswordlessUserVerificationRequirement": "not specified", 
        "webAuthnPolicyPasswordlessCreateTimeout": 0, 
        "webAuthnPolicyPasswordlessAvoidSameAuthenticatorRegister": false, 
        "webAuthnPolicyPasswordlessAcceptableAaguids": [], 
        "browserSecurityHeaders": { 
            "contentSecurityPolicyReportOnly": "", 
            "xContentTypeOptions": "nosniff", 
            "xRobotsTag": "none", 
            "xFrameOptions": "SAMEORIGIN", 
            "contentSecurityPolicy": "frame-src 'self'; frame-ancestors 'self'; object-src 'none';", 
            "xXSSProtection": "1; mode=block", 
            "strictTransportSecurity": "max-age=31536000; includeSubDomains" 
        }, 
        "smtpServer": {}, 
        "loginTheme": "kobilv2", 
        "accountTheme": "kobilv2", 
        "adminTheme": "kobilv2", 
        "emailTheme": "kobilv2", 
        "eventsEnabled": false, 
        "eventsListeners": [ 
            "kobil-event", 
            "jboss-logging", 
            "copy-features" 
        ], 
        "enabledEventTypes": [], 
        "adminEventsEnabled": false, 
        "adminEventsDetailsEnabled": false, 
        "identityProviders": [], 
        "identityProviderMappers": [], 
        "internationalizationEnabled": false, 
        "supportedLocales": [], 
        "requiredActions": [ 
            { 
                "alias": "delete_account", 
                "name": "Delete Account", 
                "providerId": "delete_account", 
                "enabled": false, 
                "defaultAction": false, 
                "priority": 60, 
                "config": {} 
            }, 
            { 
                "alias": "kobil-reg-status-required-action", 
                "name": "KOBIL Registration Status Verification", 
                "providerId": "kobil-reg-status-required-action", 
                "enabled": true, 
                "defaultAction": false, 
                "priority": 1001, 
                "config": {} 
            } 
        ], 
        "browserFlow": "browser", 
        "registrationFlow": "registration", 
        "directGrantFlow": "direct grant", 
        "resetCredentialsFlow": "reset credentials", 
        "clientAuthenticationFlow": "clients", 
        "dockerAuthenticationFlow": "docker auth", 
        "attributes": { 
            "cibaBackchannelTokenDeliveryMode": "poll", 
            "cibaExpiresIn": "120", 
            "cibaAuthRequestedUserHint": "login_hint", 
            "oauth2DeviceCodeLifespan": "600", 
            "oauth2DevicePollingInterval": "5", 
            "SSMSUserProperty": "name", 
            "parRequestUriLifespan": "60", 
            "otpBruteForceProtected": "true", 
            "REALM_TYPE": "AST", 
            "cibaInterval": "5" 
        }, 
        "userManagedAccessAllowed": false, 
        "adminUsername": "admin", 
        "createdTimeOfTheUser": 1665076679539, 
        "enableMtan": false, 
        "clientProfiles": { 
            "profiles": [] 
        }, 
        "clientPolicies": { 
            "policies": [] 
        } 
    } 
} 

Response Status Information

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

Resource Informations​

Request​

Request headers​

HTTP request URL for SSMS​

HTTP request URL for SHIFT​

Parameters​

Request body​

Response​

Data Representation​

Sample Response​

Response Status Information​