Type Alias CreateScopedApiKeyInput

Input for creating a new API key

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

Index

Properties

`Optional`description

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

Optional description for the API key

displayName

displayName: Scalars["String"]

The display name for the new API key

environmentId

environmentId: Scalars["UUID"]

The unique identifier for the environment

scopes

scopes: ApiKeyScopeInput[]

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