Get App Info

Get App Info API will return the app info that match the given parameters.

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/apps/{appname}

OR

GET https://{tenantId}.{hostname}/digitanium/v4/app/fetch?appname={appname}

HTTP request URL for SHIFT

GET https://{hostname}/auth/realms/{tenantId}/v3_client/{appname}

note

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

Parameters

Parameter Name	Type	Description
appname	String	Unique appName of the application.

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	Array	List of all app details for the given parameter.
appName	String	Unique appName of the application.
id	String	This is a unique auto-generated id.
enabled	boolean	Is this enabled or not? true = enable & false = disable, Defaults to true.
appAuthenticatorType	String	Type of Two-factor verification to sign-in to your accounts
bearerOnly	boolean	This client's access form is bearer-only. true = enable & false = disable, Defaults to false.
consentRequired	boolean	Users have to agree to client access if allowed. true = enable & false = disable, Defaults to false.
standardFlowEnabled	boolean	Enable or not to enable standard flow for this client. true = enable & false = disable, Defaults to true.
implicitFlowEnabled	boolean	Enable or not to enable implicit flow for this client. true = enable & false = disable, Defaults to true.
directAccessGrantsEnabled	boolean	Enable or not to enable directAccessGrants for this client. true = enable & false = disable, Defaults to false.
serviceAccountsEnabled	boolean	Enable or not to enable serviceAccounts for this client. true = enable & false = disable, Defaults to true.
publicApp	boolean	Is the access type for this app is public or not? true = enable & false = disable, Defaults to false.
authenticationFlowBindingOverrides	Map(String,String)	Flow bindings for realm authentication can be customized.
webOrigins	List(String)	List of allowed origins.
attributes	Map(String,String)	Based on the user requirement the user attributes can be updated. User can add any customized attribute in form of key value pair.
defaultRoles	String	A list of this client's default roles. If the client functions referenced are not included, And if they already exist, they can be created.
frontchannelLogout	boolean	For this client, frontchannel logout is or is not enabled. true = enable & false = disable, Defaults to false.
fullScopeAllowed	boolean	Whether or not the "Full Scope Allowed" function is set for this client. true = enable & false = disable, Defaults to true.
nodeReRegistrationTimeout	Integer	Cluster node timeout for this client's re-registration.
notBefore	Integer	Revoke all tokens for this client given previous to this date (this is a UNIX timestamp).
protocol	String	It defines the protocol for which this protocol mapper is involved.
protocolMappers	List(ProtocolMapperRepresentation)	A list of information for this client that describe protocol mappers.
redirectUris	List(String)	Appropriate URIs for this client for redirection.
registeredNodes	Map(String,String)	Registered cluster node dictation with nodename as the key and the last time of registration as the value.
surrogateAuthRequired	boolean	Whether or not it is required to substitute auth. true = enable & false = disable, Defaults to false.

Sample Response

{
    "message": "App info fetched successfully",
    "status": "OK",
    "subSystem": 2,
    "data": {
        "appName": "new_client",
        "id": "5016e3bb-8c88-4c53-8957-af86c43e3d0b",
        "enabled": true,
        "appAuthenticatorType": "client-secret",
        "bearerOnly": false,
        "consentRequired": false,
        "standardFlowEnabled": true,
        "implicitFlowEnabled": false,
        "directAccessGrantsEnabled": false,
        "serviceAccountsEnabled": true,
        "publicApp": false,
        "authenticationFlowBindingOverrides": {xxxxx},
        "attributes": {xxxxx},
        "webOrigins": [xxxx],
        "defaultRoles": [xxx],
        "frontchannelLogout": false,
        "fullScopeAllowed": true,
        "nodeReRegistrationTimeout": -1,
        "notBefore": 0,
        "protocol": "openid-connect",
        "protocolMappers": [xxxx],
        "redirectUris": [xxx],
        "registeredNodes": {xxxx},
        "surrogateAuthRequired": false
    }
}

Response Status Information

Status Code	Status	Message
200	OK	App info fetched successfully.
401	Unauthorized	HTTP 401 Unauthorized.
404	APP_NOT_FOUND_STATUS	App does not exist.