Team API Keys

Overview

Team API keys are designed for service accounts that manage Open Authorization API (OAA) integrations assigned to a team. Similar to personal API keys, these keys authenticate API requests, and can be revoked or reinstated to control programmatic access to Veza. Each key is associated with a single team and has the oaa_push role, restricted to specific read and write operations for creating and updating OAA data sources.

Team API keys are limited to the following operations:

Administrators can create and manage team API keys using the endpoints documented below. Note that Team API Keys are currently provided as an early access feature, and /preview/ API operations are subject to change as capabilities are added or modified.

List Team API Keys

Method: GET Endpoint: /api/preview/teamkeys

Returns API key details such as last activity time and status. If the query includes a team_id filter expression, only keys for that team are listed.

Note: When using a personal API key for a non-root team, the team_id filter is automatically applied. Only root team administrators can view keys across all teams.

List API keys for teams

GET/api/preview/teamkeys

Query parameters

Response

Body

valuesarray of TeamAPIKey (object)

next_page_tokenstring

Request

const response = await fetch('/api/preview/teamkeys', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "values": [
    {
      "id": "text",
      "access_key": "text",
      "name": "text",
      "created_at": "2024-11-18T05:33:18.249Z",
      "last_access_at": "2024-11-18T05:33:18.249Z",
      "team_id": "text"
    }
  ],
  "next_page_token": "text"
}

Example Request:

curl -X GET "https://<base-url>/api/preview/teamkeys?filter=team_id+eq+%2260437fa0-15ab-4c1f-a211-010543ac8a89%22" \
 -H "accept: application/json"

Example Response:

{
  "values": [
    {
      "id": "54807783-c5ec-4efd-9d1b-853bada658dd",
      "access_key": "",
      "name": "AWS Team Key",
      "created_at": "2024-06-25T08:30:17.087351612Z",
      "last_access_at": "2024-06-25T08:30:17.087351612Z",
      "status": "ACTIVE",
      "team_id": "60437fa0-15ab-4c1f-a211-010543ac8a89"
    }
  ],
  "next_page_token": ""
}

Create Team API Key

Method: POST Endpoint: /api/preview/teamkeys

Create an API key by providing a key name and team team_id. The response includes the access_key, which cannot be retrieved again.

Create a new team API key for a service account

POST/api/preview/teamkeys

Body

namestring

Human friendly name

team_idstring

Service account's team ID

Response

Body

valueTeamAPIKey (object)

API Key

Request

const response = await fetch('/api/preview/teamkeys', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "value": {
    "id": "text",
    "access_key": "text",
    "name": "text",
    "created_at": "2024-11-18T05:33:18.249Z",
    "last_access_at": "2024-11-18T05:33:18.249Z",
    "team_id": "text"
  }
}

Example Request:

curl -X POST "https://<base-url>/api/preview/teamkeys" \
 -H "accept: application/json" \
 -H "content-type: application/json" \
 -d '{"name":"New Team API Key","team_id":"60437fa0-15ab-4c1f-a211-010543ac8a89"}'

Example Response:

{
  "value": {
    "id": "7ddd5e0c-29cd-41c5-b41f-884b2d24b05d",
    "access_key": "<access key>",
    "name": "New Team API Key",
    "created_at": "2024-08-26T21:29:59.409761363Z",
    "last_access_at": "2024-08-26T21:29:59.409761363Z",
    "status": "ACTIVE",
    "team_id": "60437fa0-15ab-4c1f-a211-010543ac8a89"
  }
}

Remove Team API Key

Method: DELETE Endpoint: /api/preview/teamkeys/{id}

Permanently delete a team API key.

Remove team API Key

DELETE/api/preview/teamkeys/{id}

Path parameters

id*string

Response

Body

valueTeamAPIKey (object)

API Key

Request

const response = await fetch('/api/preview/teamkeys/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "value": {
    "id": "text",
    "access_key": "text",
    "name": "text",
    "created_at": "2024-11-18T05:33:18.249Z",
    "last_access_at": "2024-11-18T05:33:18.249Z",
    "team_id": "text"
  }
}

Example Request:

curl -X DELETE "https://<base-url>/api/preview/teamkeys/7ddd5e0c-29cd-41c5-b41f-884b2d24b05d" \
 -H "accept: application/json"

Example Response:

{
  "value": {
    "id": "7ddd5e0c-29cd-41c5-b41f-884b2d24b05d",
    "access_key": "",
    "name": "Updated API Key",
    "created_at": "2024-08-26T21:29:59.409761363Z",
    "last_access_at": "2024-08-26T21:29:59.409761363Z",
    "status": "INACTIVE",
    "team_id": "60437fa0-15ab-4c1f-a211-010543ac8a89"
  }
}

Revoke Team API Key

Method: POST Endpoint: /api/preview/teamkeys/{id}:revoke

Suspend usage of a team API key, changing the status to INACTIVE.

Revoke team API Key

POST/api/preview/teamkeys/{id}:revoke

Path parameters

id*string

Response

Body

RevokeTeamAPIKeyResponse (object)

Request

const response = await fetch('/api/preview/teamkeys/{id}:revoke', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{}

Example Request:

curl -X POST "https://<base-url>/api/preview/teamkeys/7ddd5e0c-29cd-41c5-b41f-884b2d24b05d:revoke" \
 -H "accept: application/json"

Example Response:

{}

Reinstate Team API Key

Method: POST Endpoint: /api/preview/teamkeys/{id}:reinstate

Reinstates a previously revoked team API key, changing the status to ACTIVE.

Reinstate a revoked team API Key

POST/api/preview/teamkeys/{id}:reinstate

Path parameters

id*string

Response

Body

ReinstateTeamAPIKeyResponse (object)

Request

const response = await fetch('/api/preview/teamkeys/{id}:reinstate', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{}

Example Request:

curl -X POST "https://<base-url>/api/preview/teamkeys/7ddd5e0c-29cd-41c5-b41f-884b2d24b05d:reinstate" \
 -H "accept: application/json"

Example Response:

{}

Update Team API Key

Method: PATCH Endpoint: /api/preview/teamkeys/{value.id}

Use this operation to update the display name of a team API key.

Update team API key metadata

PATCH/api/preview/teamkeys/{value.id}

Path parameters

value.id*string

Query parameters

Body

idstring

The unique identifier of this API key.

access_keystring

Base64 encoded access token. Only available when creating a key

namestring

User provided name for this key

created_atstring (date-time)

ISO-8601 timestamp of when this key was created

last_access_atstring (date-time)

ISO-8601 timestamp of when this key was last updated

statusinteger (enum)

Status of the key. Key is ACTIVE or INACTIVE. API keys can only be used when they are ACTIVE

team_idstring

Team ID that this key belongs to

Response

Body

valueTeamAPIKey (object)

API Key

Request

const response = await fetch('/api/preview/teamkeys/{value.id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "value": {
    "id": "text",
    "access_key": "text",
    "name": "text",
    "created_at": "2024-11-18T05:33:18.249Z",
    "last_access_at": "2024-11-18T05:33:18.249Z",
    "team_id": "text"
  }
}

Example Request:

curl -X PATCH "https://<base-url>/api/preview/teamkeys/7ddd5e0c-29cd-41c5-b41f-884b2d24b05d" \
 -H "accept: application/json"\
 -H "content-type: application/json" \
 -d '{"name":"Updated API Key"}'

Example Response:

{
  "value": {
    "id": "7ddd5e0c-29cd-41c5-b41f-884b2d24b05d",
    "access_key": "",
    "name": "Updated API Key",
    "created_at": "2024-08-26T21:29:59.409761363Z",
    "last_access_at": "2024-08-26T21:29:59.409761363Z",
    "status": "ACTIVE",
    "team_id": "60437fa0-15ab-4c1f-a211-010543ac8a89"
  }
}

PreviousTeam and User Management APIs NextRelease Notes

Last updated 2 months ago