Account Management

Account Management operations

Get the Account

Role Requirements

account-admin

Description

Gets an Account.

Securitybearer
Request
header Parameters
x-account-id
required
string

The Account Id.

x-correlation-id
string

Correlation Id for the request.

Responses
200

OK - Returns the Account response.

401

Unauthorized

403

Forbidden

get/v1/account
Request samples 
Response samples 
application/json
{
  • "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
  • "imburseAccountRef": "string",
  • "companyName": "string",
  • "billingContactFirstName": "string",
  • "billingContactLastName": "string",
  • "tenantCreationApprovalRequired": true,
  • "billingContactAddress": {
    • "streetAddress": "string",
    • "extendedAddress": "string",
    • "locality": "string",
    • "region": "string",
    • "postCode": "string",
    • "country": "string"
    },
  • "license": {
    • "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
    • "licenseName": "string",
    • "maxTenants": 0,
    • "maxTransactions": 0,
    • "maxCollectApps": 0,
    • "maxPayoutApps": 0,
    • "licensePeriodStartDate": "2019-08-24T14:15:22Z",
    • "licensePeriodEndDate": "2019-08-24T14:15:22Z",
    • "tenantUsage": 0,
    • "enableMandates": true
    }
}
Update the Account
Role Requirements


account-admin


Description


Updates an Account.


Securitybearer 
Request 
header Parameters
x-account-id
required
string
The Account Id.


 
x-correlation-id
string
Correlation Id for the request.


 
Request Body schema: 
tenantCreationApprovalRequired
boolean
Toggles the approval workflow for newly created Tenants.


 
Responses 
204
No Content.


401
Unauthorized


403
Forbidden


put/v1/account
Request samples 
{
  • "tenantCreationApprovalRequired": true
}
Get the Account Licensing History
Role Requirements


account-admin


Description


Gets the Licensing History for an Account.


Securitybearer 
Request 
header Parameters
x-account-id
required
string
The Account Id.


 
x-correlation-id
string
Correlation Id for the request.


 
Responses 
200
OK - Returns the Account Licensing History response.


401
Unauthorized


403
Forbidden


get/v1/account/licensing-history
Request samples 
Response samples 
application/json
{
  • "accountHistory": [
    • {
      • "timestamp": "2019-08-24T14:15:22Z",
      • "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
      • "licenseName": "string",
      • "maxTenants": 0,
      • "maxTransactions": 0,
      • "maxCollectApps": 0,
      • "maxPayoutApps": 0
      }
    ]
}
Request an Account License upgrade
Role Requirements


account-admin


Description


Request an upgrade to your Account license.


Securitybearer 
Request 
header Parameters
x-account-id
required
string
The Account Id.


 
x-correlation-id
string
Correlation Id for the request.


 
Request Body schema: 
emailAddress
string or null
Email address of the user making the upgrade request.


 
maxTenants
integer <int32> 
Max number of Tenants required.


 
maxTransactions
integer <int32> 
Max number of Transactions required.


 
reason
string or null
A short reason for the licensing limit upgrade.


 
Responses 
202
Accepted.


401
Unauthorized


403
Forbidden


post/v1/account/upgrade-request
Request samples 
{
  • "emailAddress": "string",
  • "maxTenants": 0,
  • "maxTransactions": 0,
  • "reason": "string"
}
Get IP Whitelist configuration for Account.
Role Requirements


account-admin


Description


Gets the IP Whitelist configuration for Account-scoped API Key users.


Securitybearer 
Request 
header Parameters
x-account-id
required
string
The Account Id.


 
x-correlation-id
string
Correlation Id for the request.


 
Responses 
200
OK - Returns the IP Whitelist configuration response.


401
Unauthorized


403
Forbidden


get/v1/account/ip-whitelist
Request samples 
Response samples 
application/json
{
  • "enabled": true,
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "rules": [
    • {
      • "name": "string",
      • "ipV4Start": "string",
      • "ipV4End": "string"
      }
    ]
}
Update IP Whitelist configuration for Account.
Role Requirements


account-admin


Description


Updates the IP Whitelist configuration for Account-scoped API Key users.


Securitybearer 
Request 
header Parameters
x-account-id
required
string
The Account Id.


 
x-correlation-id
string
Correlation Id for the request.


 
Request Body schema: 
enabled
required
boolean
IP Whitelist configuration enabled.


 
required
Array of objects (IpWhitelistConfigurationRuleV1) 
Collection of IP Whitelist rules defining allowed IP ranges.


 
Responses 
204
No Content.


401
Unauthorized


403
Forbidden


put/v1/account/ip-whitelist
Request samples 
{
  • "enabled": true,
  • "rules": [
    • {
      • "name": "string",
      • "ipV4Start": "string",
      • "ipV4End": "string"
      }
    ]
}
Copyright 2024 Duck Creek Technologies. All Rights Reserved.