Getting Information by Specifying Secondary Account ID
You can get the previous secondary account for Browser Transfer settings information by specifying the previous secondary account for Browser Transfer ID.
Request Interface
HTTP Request
GET /secondary-account/definition/{secondaryAccountId}
Parameter
Path Parameter |
Value |
Required |
Description |
Default Value |
---|---|---|---|---|
secondaryAccountId |
string |
true |
ID to specify a previous secondary account for Browser Transfer |
|
Authorization
In the API Key Management screen in Management Console, 'Previous secondary account for Browser Transfer Settings' under the 'Scopes' field must be selected as 'Get'.
Response Interface
If the request is processed successfully, the following response is returned in JSON format.
{ "secondaryAccountId": "xxxxxxxxxxxxxxxxxxxxxx", "secondaryAccount": "xxxxxxxxxxxxxxxxxxxxxxx", "passwordPolicy": { "passwordManagement": 1, "passwordExpireOn": 30 }, "browserToHulftDefinitions": [ { "id": "hoge", "description": ".." }, { "id": "fuga", "description": ".." } ], "hulftToBrowserDefinitions": [], "ipFilterGroupName": "xxxxxxxxxxxxxxxxxxxxxxx", "memo": "xxxxxxxxxxxxxxxxxxxxxxx", "isAvailableMail": false, "statusCode": 0 }
Property Name |
Value |
Description |
---|---|---|
secondaryAccountId |
string |
ID to specify a previous secondary account for Browser Transfer |
secondaryAccount |
string |
Previous secondary account for Browser Transfer (email address) |
passwordPolicy |
object |
The password policy |
passwordManagement |
integer |
Password Management Method (0: Management by a user with a previous secondary account for Browser Transfer, 1: Management by the contractor) |
passwordExpireOn |
integer |
The password validity period (0 (the password never expires) or 30 to 365 days) |
browserToHulftDefinitions |
array |
Transfer settings (for Send File) |
id |
string |
Transfer Settings ID (for Send File) |
description |
string |
Description of the transfer settings (for Send File) |
hulftToBrowserDefinitions |
array |
Transfer settings (for Send Request) |
id |
string |
Transfer Settings ID (for Send Request) |
description |
string |
Description of the transfer settings (for Send Request) |
ipFilterGroupName |
string |
IP Filter Group Name |
memo |
string |
Note for the previous secondary account for Browser Transfer |
isAvailableMail |
boolean |
Whether or not to send an email to the email address |
statusCode |
integer |
The status of the previous secondary account for Browser Transfer (0: New creation, 1: In use, 2: While changing Password Management Method, 3: While changing the email address) |
Examples
public static void main(String[] args) { String host = "https://www.webconnect.hulft.com"; String apiKey = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"; String secondaryAccountId = "xxxxxxxx"; try { URL url = new URL(host + "/api/v2/secondary-account/definition/" + secondaryAccountId); HttpURLConnection connection = (HttpURLConnection) url.openConnection(); connection.setRequestMethod("GET"); connection.setRequestProperty("Authorization", "Bearer " + apiKey); try (BufferedReader reader = new BufferedReader(new InputStreamReader(connection.getInputStream()))) { String line; while((line = reader.readLine()) != null) { System.out.println(line); } } } catch (IOException ex) { // error } }
// load jquery var host = 'https://www.webconnect.hulft.com'; var apiKey = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'; var secondaryAccountId = 'xxxxxxxx'; $.ajax({ type: 'GET', url: host + '/api/v2/secondary-account/definition/' + secondaryAccountId, headers: { Authorization: 'Bearer ' + apiKey } }).done(function(data, status, xhr) { console.log(data); }).fail(function(data, status, xhr) { console.log(data); });