# ApiKey

**Package:** `flyteplugins.union.remote`

Represents a Union API Key (OAuth Application).

    API Keys in Union are OAuth 2.0 applications that can be used for
    headless authentication. They support client credentials flow for
    machine-to-machine authentication.

    Attributes:
        pb2: The underlying protobuf App message
        organization: The organization this API key belongs to (for serverless)
        encoded_credentials: Base64-encoded credentials for UNION_API_KEY env var

    Example:
        # Create a new API key
        api_key = ApiKey.create(name="ci-pipeline")
        print(f"export FLYTE_API_KEY="{api_key.encoded_credentials}"")

        # List all API keys
        for key in ApiKey.listall():
            print(f"{key.client_id}: {key.client_name}")

        # Get a specific API key
        key = ApiKey.get(client_id="my-client-id")

        # Delete an API key
        ApiKey.delete(client_id="my-client-id")
    
## Parameters

```python
class ApiKey(
    pb2: App,
    organization: str | None,
    encoded_credentials: str | None,
)
```
| Parameter | Type | Description |
|-|-|-|
| `pb2` | `App` | |
| `organization` | `str \| None` | |
| `encoded_credentials` | `str \| None` | |

## Properties

| Property | Type | Description |
|-|-|-|
| `client_id` | `None` | The OAuth client ID. |
| `client_name` | `None` | The human-readable name of the API key. |
| `client_secret` | `None` | The OAuth client secret (only available on creation). |

## Methods

| Method | Description |
|-|-|
| [`create()`](#create) | Create a new API key. |
| [`delete()`](#delete) | Delete an API key. |
| [`get()`](#get) | Get an API key by client ID. |
| [`listall()`](#listall) | List all API keys. |
| [`to_dict()`](#to_dict) | Convert the object to a JSON-serializable dictionary. |
| [`to_json()`](#to_json) | Convert the object to a JSON string. |
| [`update()`](#update) | Update an API key. |

### create()

> [!NOTE] This method can be called both synchronously or asynchronously.
> Default invocation is sync and will block.
> To call it asynchronously, use the function `.aio()` on the method name itself, e.g.,:
> `result = await ApiKey.create.aio()`.
```python
def create(
    cls,
    name: str,
    redirect_uris: list[str] | None,
) -> ApiKey
```
Create a new API key.

Example:
    api_key = ApiKey.create(name="ci-pipeline")
    print(f"Client ID: {api_key.client_id}")
    print(f"Client Secret: {api_key.client_secret}")
    print(f"Encoded: {api_key.encoded_credentials}")

| Parameter | Type | Description |
|-|-|-|
| `cls` |  | |
| `name` | `str` | Human-readable name for the API key |
| `redirect_uris` | `list[str] \| None` | OAuth redirect URIs (defaults to localhost callback) |

**Returns**

ApiKey instance with client_secret populated

**Raises**

| Exception | Description |
|-|-|
| `Exception` | If API key creation fails |

### delete()

> [!NOTE] This method can be called both synchronously or asynchronously.
> Default invocation is sync and will block.
> To call it asynchronously, use the function `.aio()` on the method name itself, e.g.,:
> `result = await ApiKey.delete.aio()`.
```python
def delete(
    cls,
    client_id: str,
)
```
Delete an API key.

Example:
    ApiKey.delete(client_id="old-ci-key")

| Parameter | Type | Description |
|-|-|-|
| `cls` |  | |
| `client_id` | `str` | The OAuth client ID to delete |

**Raises**

| Exception | Description |
|-|-|
| `Exception` | If deletion fails |

### get()

> [!NOTE] This method can be called both synchronously or asynchronously.
> Default invocation is sync and will block.
> To call it asynchronously, use the function `.aio()` on the method name itself, e.g.,:
> `result = await ApiKey.get.aio()`.
```python
def get(
    cls,
    client_id: str,
) -> ApiKey
```
Get an API key by client ID.

Example:
    key = ApiKey.get(client_id="my-client-id")
    print(key.client_name)

| Parameter | Type | Description |
|-|-|-|
| `cls` |  | |
| `client_id` | `str` | The OAuth client ID |

**Returns**

ApiKey instance

**Raises**

| Exception | Description |
|-|-|
| `Exception` | If API key not found |

### listall()

> [!NOTE] This method can be called both synchronously or asynchronously.
> Default invocation is sync and will block.
> To call it asynchronously, use the function `.aio()` on the method name itself, e.g.,:
> `result = await ApiKey.listall.aio()`.
```python
def listall(
    cls,
    limit: int,
) -> AsyncIterator[ApiKey]
```
List all API keys.

Yields:
    ApiKey instances

Example:
    for key in ApiKey.listall(limit=10):
        print(f"{key.client_id}: {key.client_name}")

| Parameter | Type | Description |
|-|-|-|
| `cls` |  | |
| `limit` | `int` | Maximum number of keys to return |

### to_dict()

```python
def to_dict()
```
Convert the object to a JSON-serializable dictionary.

**Returns:** dict: A dictionary representation of the object.

### to_json()

```python
def to_json()
```
Convert the object to a JSON string.

**Returns:** str: A JSON string representation of the object.

### update()

> [!NOTE] This method can be called both synchronously or asynchronously.
> Default invocation is sync and will block.
> To call it asynchronously, use the function `.aio()` on the method name itself, e.g.,:
> `result = await ApiKey.update.aio()`.
```python
def update(
    cls,
    client_id: str,
    client_name: str | None,
    redirect_uris: list[str] | None,
) -> ApiKey
```
Update an API key.

Example:
    key = ApiKey.update(
        client_id="my-key",
        client_name="renamed-key"
    )

| Parameter | Type | Description |
|-|-|-|
| `cls` |  | |
| `client_id` | `str` | The OAuth client ID to update |
| `client_name` | `str \| None` | New name for the API key |
| `redirect_uris` | `list[str] \| None` | New redirect URIs |

**Returns**

Updated ApiKey instance

**Raises**

| Exception | Description |
|-|-|
| `Exception` | If update fails |

---
**Source**: https://github.com/unionai/unionai-docs/blob/main/content/api-reference/integrations/union/packages/flyteplugins.union.remote/apikey.md
**HTML**: https://www.union.ai/docs/v2/byoc/api-reference/integrations/union/packages/flyteplugins.union.remote/apikey/