List Tenants

Use this API to return the list of tenants along with their details.

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://{tenantId}.{hostname}/digitanium/v4/tenants

HTTP request URL for SHIFT

GET https://{hostname}/auth/realms/{MASTER}/v4_realm/

note

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

Parameters

No parameter 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.
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.
adminUsername	String	Returns username of any one of the admin.
userCount	Integer	The number of users.
realmCreationStatus	String	Refer Get Realm Creation Status

Sample Response

{
    "message": "Tenant list fetched successfully",
    "status": "OK",
    "subSystem": 1,
    "data": [
        {
            "name": "TestHeadlessV2",
            "type": "AST",
            "enabled": true,
            "rememberMe": false,
            "resetPassword": false,
            "registrationAllowed": false,
            "adminUsername": "admin11",
            "userCount": 3,
            "realmCreationStatus": "BLOCKED"
        },
        {
            "name": "TestSSMS",
            "type": "SSMS",
            "enabled": true,
            "rememberMe": false,
            "resetPassword": false,
            "registrationAllowed": false,
            "adminUsername": "admin",
            "userCount": 1,
            "realmCreationStatus": "BLOCKED"
        },
        
    ]
}

Response Status Information

Status Code	Status	Message
200	OK	Tenant list fetched successfully
401	Unauthorized	HTTP 401 Unauthorized