Tenant Key Management

Tenant Key Management operations

Get Tenant Keys

Role Requirements

tenant-admin

Description

Gets the Keys for the Tenant

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 Keys response.

401

Unauthorized

403

Forbidden

get/v2/tenant/keys
Request samples 
Response samples 
application/json
{
  • "tenantKeys": [
    • {
      • "identity": "string",
      • "name": "string",
      • "publicKey": "string",
      • "roles": [
        • "string"
        ]
      }
    ]
}
Create Tenant Key
Role Requirements


tenant-admin


Description


Creates a new Tenant Key for the Tenant.


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
A friendly name for this Key.


 
roles
Array of strings or null
The roles this Key should have.


 
Responses 
201
Created - Returns the Vaulted Key response.


401
Unauthorized


403
Forbidden


post/v2/tenant/keys
Request samples 
{
  • "name": "string",
  • "roles": [
    • "string"
    ]
}
Response samples 
application/json
{
  • "identity": "string",
  • "name": "string",
  • "publicKey": "string",
  • "privateKey": "string",
  • "roles": [
    • "string"
    ]
}
Get Tenant Key
Role Requirements


tenant-admin


Description


Gets a Tenant Key by the publicKey.


Securitybearer 
Request 
path Parameters
publicKey
required
string <uuid> 
The Public Key.


 
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 Key response.


401
Unauthorized


403
Forbidden


get/v2/tenant/keys/{publicKey}
Request samples 
Response samples 
application/json
{
  • "identity": "string",
  • "name": "string",
  • "publicKey": "string",
  • "roles": [
    • "string"
    ]
}
Update Tenant Key
Role Requirements


tenant-admin


Description


Updates a Tenant Key by the publicKey.


Securitybearer 
Request 
path Parameters
publicKey
required
string <uuid> 
The Public Key.


 
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
A friendly name for this Key.


 
roles
Array of strings or null
The roles this Key should have.


 
Responses 
204
No Content.


401
Unauthorized


403
Forbidden


put/v2/tenant/keys/{publicKey}
Request samples 
{
  • "name": "string",
  • "roles": [
    • "string"
    ]
}
Delete Tenant Key
Role Requirements


tenant-admin


Description


Deletes a Tenant Key by the publicKey.


Securitybearer 
Request 
path Parameters
publicKey
required
string <uuid> 
The Public Key.


 
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 
204
No Content.


401
Unauthorized


403
Forbidden


delete/v2/tenant/keys/{publicKey}
Request samples 
Copyright 2024 Duck Creek Technologies. All Rights Reserved.