snowflake.core.catalog_integration.OAuth

class snowflake.core.catalog_integration.OAuth(*, oauth_client_id: Annotated[str, Strict(strict=True)], oauth_client_secret: Annotated[str, Strict(strict=True)], oauth_allowed_scopes: List[Annotated[str, Strict(strict=True)]])

Bases: RestAuthentication

A model object representing the OAuth resource.

Constructs an object of type OAuth with the provided properties.

Parameters:

  • oauth_client_id (str) – The client ID of the OAuth2 credential associated with the Polaris service connection.

  • oauth_client_secret (str) – The secret for the OAuth2 credential associated with the Polaris service connection.

  • oauth_allowed_scopes (List[str]) – The scope of the OAuth token. Only one scope is included in the Iceberg REST API specification, but catalogs can support more than one scope in their implementation.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Methods

classmethod from_dict(obj: dict) → OAuth

Create an instance of OAuth from a dict.

classmethod from_json(json_str: str) → OAuth

Create an instance of OAuth from a JSON string.

to_dict(hide_readonly_properties: bool = False) → Dict[str, Any]

Returns the dictionary representation of the model using alias.

to_dict_without_readonly_properties() → Dict[str, Any]

Return the dictionary representation of the model without readonly properties.

to_json() → str

Returns the JSON representation of the model using alias.

to_str() → str

Returns the string representation of the model using alias.

Language: English