Tenant Management

Tenant Management operations

Get the Tenant

Role Requirements

tenant-management or tenant-admin

Description

Gets the Tenant associated with the current API key.

Securitybearer
Request
header Parameters
x-account-id
required
string

The Account Id.

x-tenant-id
required
string

The Tenant Id.

x-correlation-id
string

Correlation Id for the request.

Responses
200

OK - Returns the Tenant response.

401

Unauthorized

403

Forbidden

get/v1/tenant
Request samples 
Response samples 
application/json
{
  • "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "name": "string",
  • "status": "string",
  • "address": {
    • "streetAddress": "string",
    • "extendedAddress": "string",
    • "locality": "string",
    • "region": "string",
    • "postCode": "string",
    • "country": "string"
    },
  • "statusDetails": {
    • "createdOn": "2019-08-24T14:15:22Z",
    • "createdBy": "string",
    • "approvedOn": "2019-08-24T14:15:22Z",
    • "approvedBy": "string",
    • "rejectedOn": "2019-08-24T14:15:22Z",
    • "rejectionReason": "string",
    • "rejectedBy": "string",
    • "deletedOn": "2019-08-24T14:15:22Z",
    • "deletedBy": "string"
    }
}
Update the Tenant
Role Requirements


tenant-management or tenant-admin


Description


Updates the Tenant associated with the current API key.


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


 
x-tenant-id
required
string
The Tenant Id.


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


 
Request Body schema: 
name
string or null
The name of the Tenant.


 
streetAddress
string or null
The first line of address.


 
extendedAddress
string or null
Optional second line of address.


 
locality
string or null
Locality / city of address.


 
region
string or null
Region name of Tenant.


 
postCode
string or null
Post code of Tenant.


 
country
string or null
Country name.


 
Responses 
202
Accepted.


401
Unauthorized


403
Forbidden


put/v1/tenant
Request samples 
{
  • "name": "string",
  • "streetAddress": "string",
  • "extendedAddress": "string",
  • "locality": "string",
  • "region": "string",
  • "postCode": "string",
  • "country": "string"
}
Get IP Whitelist configuration for Tenant
Role Requirements


tenant-management or tenant-admin


Description


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


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


 
x-tenant-id
required
string
The Tenant Id.


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


 
Responses 
200
Returns the IP Whitelist configuration response.


401
Unauthorized


403
Forbidden


get/v1/tenant/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 Tenant
Role Requirements


tenant-management or tenant-admin


Description


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


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


 
x-tenant-id
required
string
The Tenant 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/tenant/ip-whitelist
Request samples 
{
  • "enabled": true,
  • "rules": [
    • {
      • "name": "string",
      • "ipV4Start": "string",
      • "ipV4End": "string"
      }
    ]
}
Get a Tenant's enabled service settings
Securitybearer 
Request 
header Parameters
x-account-id
required
string
The Account Id.


 
x-tenant-id
required
string
The Tenant Id.


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


 
Responses 
200
OK - Returns the Tenant services response.


401
Unauthorized


get/v1/tenant/services
Request samples 
Response samples 
application/json
{
  • "services": [
    • {
      • "name": "string",
      • "enabled": true
      }
    ]
}
Copyright 2024 Duck Creek Technologies. All Rights Reserved.