cloudflare/src/resources/iam/oauth-scopes.ts

The official TypeScript library for the Cloudflare API

// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

import { APIResource } from '../../core/resource';
import { PagePromise, SinglePage } from '../../core/pagination';
import { RequestOptions } from '../../internal/request-options';

export class BaseOAuthScopes extends APIResource {
  static override readonly _key: readonly ['iam', 'oauthScopes'] = Object.freeze([
    'iam',
    'oauthScopes',
  ] as const);

  /**
   * List all available OAuth scopes. This endpoint requires authentication but has
   * no authorization role requirements.
   *
   * @example
   * ```ts
   * // Automatically fetches more pages as needed.
   * for await (const oauthScopeListResponse of client.iam.oauthScopes.list()) {
   *   // ...
   * }
   * ```
   */
  list(options?: RequestOptions): PagePromise<OAuthScopeListResponsesSinglePage, OAuthScopeListResponse> {
    return this._client.getAPIList('/oauth/scopes', SinglePage<OAuthScopeListResponse>, options);
  }
}
export class OAuthScopes extends BaseOAuthScopes {}

export type OAuthScopeListResponsesSinglePage = SinglePage<OAuthScopeListResponse>;

/**
 * An available OAuth scope that can be assigned to an OAuth client.
 */
export interface OAuthScopeListResponse {
  /**
   * The scope label to use in the scopes array when creating or updating an OAuth
   * client.
   */
  id: string;

  /**
   * Human-readable name of the OAuth scope.
   */
  name: string;

  /**
   * Category for grouping scopes in the UI.
   */
  category?: string;

  /**
   * The underlying resource scopes (Bach scopes) that define which resources this
   * OAuth scope can act upon.
   */
  scopes?: Array<string>;
}

export declare namespace OAuthScopes {
  export {
    type OAuthScopeListResponse as OAuthScopeListResponse,
    type OAuthScopeListResponsesSinglePage as OAuthScopeListResponsesSinglePage,
  };
}