---
title: "Tenant KMS Assignment List"
method: GET
path: "/1/tenants/{tenantId}/assignments"
tags: ["Configuration Assignment"]
---

# Tenant KMS Assignment List

`GET /1/tenants/{tenantId}/assignments`

## Request

- Base URL: `http://localhost:3000/api`
- URL: `http://localhost:3000/api/1/tenants/{tenantId}/assignments`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/ironcorelabs/apis/vendor-api-bridge/docs/1/tenants/:tenantId/assignments/get.ts> (a function with typed inputs; its response is checked against the schema)

List the KMS assignments associated with the provided tenant.

## Query parameters

- `sortColumn` 'active' | 'primary' | 'created' | 'updated'
- `status` 'active' | 'disabled' | 'primary'
- `query` string
- `pageSize` integer
- `page` integer
- `sortDirection` 'asc' | 'desc'

## Headers

- `icl-requestor-id` string, required

## Response `200`

Result of listing KMS configuration assignments

- object
  - `result` KmsConfigAssignmentResponse[], required: KMS configuration assignments
    - `kmsConfigId` integer, required: KMS configuration ID
    - `tenantId` string, required: Tenant ID
    - `active` boolean, required: Whether the associated KMS configuration can be used to encrypt/decrypt calls.
    - `primary` boolean, required: Whether the associated KMS configuration will be used for encrypt calls.
    - `createdBy` CreatedBy, required: Metadata about creating user/service
      - `id` string, required: Creator ID
      - `name` string, required: Creator name
      - `type` 'Tsp' | 'Admin' | 'Va', required: Creator type
    - `created` string, required: RFC3339 timestamp
    - `updated` string, required: RFC3339 timestamp
  - `page` integer, required: Current response page number
  - `totalPages` integer, required: Total number of response pages

## Other responses

- `401`: Unauthorized

---

[API](https://skmtc.dev/ironcorelabs/apis/vendor-api-bridge.md) - [All operations](https://skmtc.dev/ironcorelabs/apis/vendor-api-bridge/llms.txt) - [OpenAPI document](https://skmtc.dev/ironcorelabs/apis/vendor-api-bridge/revisions/5c0e553ffa21?raw)