cloudflare/resources/accounts/tokens/permission-groups.d.mts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../../core/resource.mjs";
import { APIPromise } from "../../../core/api-promise.mjs";
import { PagePromise, SinglePage } from "../../../core/pagination.mjs";
import { RequestOptions } from "../../../internal/request-options.mjs";
export declare class BasePermissionGroups extends APIResource {
    static readonly _key: readonly ['accounts', 'tokens', 'permissionGroups'];
    /**
     * Find all available permission groups for Account Owned API Tokens. Each
     * permission group indicates whether the caller can select it when creating a
     * token. Token creation performs the authoritative permission check.
     *
     * @example
     * ```ts
     * // Automatically fetches more pages as needed.
     * for await (const permissionGroupListResponse of client.accounts.tokens.permissionGroups.list(
     *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
     * )) {
     *   // ...
     * }
     * ```
     */
    list(params: PermissionGroupListParams, options?: RequestOptions): PagePromise<PermissionGroupListResponsesSinglePage, PermissionGroupListResponse>;
    /**
     * Find all available permission groups for Account Owned API Tokens. Each
     * permission group indicates whether the caller can select it when creating a
     * token. Token creation performs the authoritative permission check.
     *
     * @example
     * ```ts
     * const permissionGroups =
     *   await client.accounts.tokens.permissionGroups.get({
     *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
     *   });
     * ```
     */
    get(params: PermissionGroupGetParams, options?: RequestOptions): APIPromise<PermissionGroupGetResponse>;
}
export declare class PermissionGroups extends BasePermissionGroups {
}
export type PermissionGroupListResponsesSinglePage = SinglePage<PermissionGroupListResponse>;
export interface PermissionGroupListResponse {
    /**
     * Public ID.
     */
    id?: string;
    /**
     * Product category that this permission group belongs to.
     */
    category?: 'developer_platform' | 'ai_and_machine_learning' | 'dns_and_zones' | 'app_security' | 'rules_and_configuration' | 'cloudflare_one_and_zero_trust' | 'analytics_and_logs' | 'network_services' | 'media' | 'email_and_messaging' | 'cache_and_performance' | 'account_and_billing' | 'other';
    /**
     * Whether the caller can select this permission group when creating a token.
     */
    is_selectable?: boolean;
    /**
     * Permission Group Name
     */
    name?: string;
    /**
     * Resources to which the Permission Group is scoped
     */
    scopes?: Array<'com.cloudflare.api.account' | 'com.cloudflare.api.account.zone' | 'com.cloudflare.api.user' | 'com.cloudflare.edge.r2.bucket'>;
}
export type PermissionGroupGetResponse = Array<PermissionGroupGetResponse.PermissionGroupGetResponseItem>;
export declare namespace PermissionGroupGetResponse {
    interface PermissionGroupGetResponseItem {
        /**
         * Public ID.
         */
        id?: string;
        /**
         * Product category that this permission group belongs to.
         */
        category?: 'developer_platform' | 'ai_and_machine_learning' | 'dns_and_zones' | 'app_security' | 'rules_and_configuration' | 'cloudflare_one_and_zero_trust' | 'analytics_and_logs' | 'network_services' | 'media' | 'email_and_messaging' | 'cache_and_performance' | 'account_and_billing' | 'other';
        /**
         * Whether the caller can select this permission group when creating a token.
         */
        is_selectable?: boolean;
        /**
         * Permission Group Name
         */
        name?: string;
        /**
         * Resources to which the Permission Group is scoped
         */
        scopes?: Array<'com.cloudflare.api.account' | 'com.cloudflare.api.account.zone' | 'com.cloudflare.api.user' | 'com.cloudflare.edge.r2.bucket'>;
    }
}
export interface PermissionGroupListParams {
    /**
     * Path param: Account identifier tag.
     */
    account_id: string;
    /**
     * Query param: Filter by the name of the permission group. The value must be
     * URL-encoded.
     */
    name?: string;
    /**
     * Query param: Filter by the scope of the permission group. The value must be
     * URL-encoded.
     */
    scope?: string;
}
export interface PermissionGroupGetParams {
    /**
     * Path param: Account identifier tag.
     */
    account_id: string;
    /**
     * Query param: Filter by the name of the permission group. The value must be
     * URL-encoded.
     */
    name?: string;
    /**
     * Query param: Filter by the scope of the permission group. The value must be
     * URL-encoded.
     */
    scope?: string;
}
export declare namespace PermissionGroups {
    export { type PermissionGroupListResponse as PermissionGroupListResponse, type PermissionGroupGetResponse as PermissionGroupGetResponse, type PermissionGroupListResponsesSinglePage as PermissionGroupListResponsesSinglePage, type PermissionGroupListParams as PermissionGroupListParams, type PermissionGroupGetParams as PermissionGroupGetParams, };
}
//# sourceMappingURL=permission-groups.d.mts.map