Fetch application connection information

Retrieve the connection information related to a application that has been granted access to this server. This data may include any number of properties, but its primary purpose is to associate API tokens and public/private key pairs and similar resources with a specific connected application.

SecurityBasicAuth

Request

query Parameters

name

required

string

The name of the connected application.

Example: name=application-1

Responses

200

HTTP Request was successful.

Response Schema: application/json

	object
	object

post/fetch_connected_application

Request samples

whmapi1 --output=jsonpretty \
  fetch_connected_application \
  name='application-1'

Response samples

application/json

{"data": {"data": {"jwt": {"callback_url": "https://application-1.com/api/si/servers/registrations/callback,",
"challenge": "ddd13a92-d55e-4818-a960-9776ede6cd74,",
"email": "john.doe@email.example,",
"exp": "1401912171,",
"ips": ["1.1.1.1",
"2.2.2.2"
],
"iss": "https://application-1.com",
"iss_desc": "Sample application",
"name": "John Doe,",
"redirect_url": "https://application-1/redirect,",
"scope": ["admin:users,",
"admin:resellers",
"admin:domains"
],
"state": "xyz"
},
"private_key": "FEF6253E6A122532430D",
"privileges_granted": ["list-accts",
"list-resellers",
"create-user-session",
"acct-summary",
"connected-applications"
],
"public_key": "AAF6253E6A1225324305623EE",
"token_name": "Application 1 API Token",
"property1": null,
"property2": null
},
"name": "application-1"
},
"metadata": {"command": "fetch_connected_application",
"reason": "OK",
"result": 1,
"version": 1
}
}