Get Tenant Credentials

Get Tenant Credentials API will return the data that match the given tenantID.

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/tenant/{tenantId}/credentials

note

At this moment, this API is applicable for SSMS based installations.

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 credential data object.
operatorName	String	Username of the operator that holds the realm role.
operatorPassword	String	Password corresponding to the Operator.
portalName	String	Username of the portal.
portalPassword	String	Password corresponding to the Portal.

Sample Response

{
    "message": "Tenant credentials fetched successfully",
    "status": "OK",
    "subSystem": 1,
    "data": {
        "operatorName": "DEV3",
        "operatorPassword": "123456",
        "portalName": "demo",
        "portalPassword": "demo123"
    }
}

Response Status Information

Status Code	Status	Message
200	OK	Tenant credentials fetched successfully
401	Unauthorized	HTTP 401 Unauthorized
403	FORBIDDEN	Failed to fetch Credentials
404	TENANT_NOT_FOUND	Tenant does not exist