Interface CreateKeyOptions

Options accepted by native B2 application-key creation.

interface CreateKeyOptions {
    bucketId?: string;
    bucketIds?: string[] | null;
    capabilities: string[];
    keyName: string;
    namePrefix?: string;
    validDurationInSeconds?: number;
}

Index

Properties

bucketId? bucketIds? capabilities keyName namePrefix? validDurationInSeconds?

Properties

`Optional`bucketId

bucketId?: string

Legacy single bucket ID scope.

`Optional`bucketIds

bucketIds?: string[] | null

Optional bucket ID scopes for the new key.

capabilities

capabilities: string[]

B2 capabilities to grant.

keyName

keyName: string

New application key display name.

`Optional`namePrefix

namePrefix?: string

Optional object key prefix restriction.

`Optional`validDurationInSeconds

validDurationInSeconds?: number

Optional key lifetime in seconds.