Skip to content

List Monitored Partner Accounts

Partners can list the monitored accounts for a partner customer using the k9 API with:

GET /partner/{partnerId}/customer/{partnerCustomerId}/account

Request Headers

Set the Content-Type header to application/json

Request Path Parameters

The list monitored partner accounts API requires two path parameters:

partnerId: the k9 Partner ID that manages the account, e.g. P123456. k9 Security will provide the Partner ID to the partner.

Type: String

Pattern: P[\d]{6}

partnerCustomerId: the partner's own unique customer or tenant identifier for the managed customer environment, e.g. a UUID, AWS Organization ID, SHA256 digest

Type: String

Pattern: [\w-_.]{6,64}

Request Body

Not Applicable

Response

Success

When you successfully list the monitored accounts, the API will respond with:

Response Status Code: 200 (Success)

Response Body (Example):

[
  {
    "partnerId": "P123456",
    "partnerCustomerId": "abcd-1234-defg-5678",
    "customerId": "P123456-430363089266",
    "provider": "aws",
    "accountId": "111111111111"
  },
  {
    "partnerId": "P123456",
    "partnerCustomerId": "abcd-1234-defg-5678",
    "customerId": "P123456-430363089266",
    "provider": "aws",
    "accountId": "222222222222"
  }
]

The customerId is the automatically managed k9 Customer ID that the partner's Customer ID is mapped to within k9. The customerId for partner-managed accounts has the form {partner_id}-{12-digit zero-padded number}

Example customerId: P123456-430363089266

Not Authorized

If the calling principal is not authorized to create the account configuration, the API will respond with:

Response Status Code: 403 (Forbidden)

Response Body (Example):

{
  "message": "Caller is not authorized to list the partner account configurations."
}

Last update: November 12, 2024