Type Alias UpdateApiKeyInput

Input for updating an API key

type UpdateApiKeyInput = {
    description?: InputMaybe<Scalars["String"]>;
    displayName?: InputMaybe<Scalars["String"]>;
    environmentId?: InputMaybe<Scalars["UUID"]>;
    expireAt?: InputMaybe<Scalars["DateTime"]>;
    id: Scalars["UUID"];
    scopes?: InputMaybe<ApiKeyScopeInput[]>;
}

Index

Properties

description? displayName? environmentId? expireAt? id scopes?

Properties

`Optional`description

description?: InputMaybe<Scalars["String"]>

Updated description for the API key

`Optional`displayName

displayName?: InputMaybe<Scalars["String"]>

Updated display name for the API key

`Optional`environmentId

environmentId?: InputMaybe<Scalars["UUID"]>

The unique identifier for the environment

`Optional`expireAt

expireAt?: InputMaybe<Scalars["DateTime"]>

Updated expiration date for the API key

id

id: Scalars["UUID"]

Unique identifier for the entity

`Optional`scopes

scopes?: InputMaybe<ApiKeyScopeInput[]>

Input for defining API key scope permissions, valid only for scoped keys