Account Key Management

Account Key Management operations

Get Account Keys

Role Requirements

account-admin

Description

Gets the Keys for the 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 Keys response.

401

Unauthorized

403

Forbidden

get/v2/account/keys
Request samples
Response samples
application/json
{
  • "accountKeys": [
    • {
      • "identity": "string",
      • "name": "string",
      • "publicKey": "string",
      • "roles": [
        • "string"
        ]
      }
    ]
}

Create Account Key

Role Requirements

account-admin

Description

Creates an Account Key.

Note - The privateKey that is returned with this request needs to be stored securely

It is not retrievable after this request.

Securitybearer
Request
header Parameters
x-account-id
required
string

The Account 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/account/keys
Request samples
{
  • "name": "string",
  • "roles": [
    • "string"
    ]
}
Response samples
application/json
{
  • "identity": "string",
  • "name": "string",
  • "publicKey": "string",
  • "privateKey": "string",
  • "roles": [
    • "string"
    ]
}

Get Account Keys

Role Requirements

account-admin

Description

Gets an Account 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-correlation-id
string

Correlation Id for the request.

Responses
200

OK - Returns the Key response.

401

Unauthorized

403

Forbidden

get/v2/account/keys/{publicKey}
Request samples
Response samples
application/json
{
  • "identity": "string",
  • "name": "string",
  • "publicKey": "string",
  • "roles": [
    • "string"
    ]
}

Delete Account Keys

Role Requirements

account-admin

Description

Deletes an Account 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-correlation-id
string

Correlation Id for the request.

Responses
204

No Content.

401

Unauthorized

403

Forbidden

delete/v2/account/keys/{publicKey}
Request samples

Update Account Key

Role Requirements

account-admin

Description

Updates an Account 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-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/account/keys/{publicKey}
Request samples
{
  • "name": "string",
  • "roles": [
    • "string"
    ]
}
Copyright 2024 Duck Creek Technologies. All Rights Reserved.