snowflake.core.secret.Oauth2Secret¶

class snowflake.core.secret.Oauth2Secret(*, comment: Annotated[str, Strict(strict=True)] | None = None, name: Annotated[str, Strict(strict=True)], created_on: datetime | None = None, database_name: Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])] | None = None, schema_name: Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])] | None = None, owner: Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])] | None = None, owner_role_type: Annotated[str, Strict(strict=True)] | None = None, oauth_refresh_token: Annotated[str, Strict(strict=True)] | None = None, oauth_refresh_token_expiry_time: Annotated[str, Strict(strict=True)] | None = None, oauth_scopes: List[Annotated[str, Strict(strict=True)]] | None = None, api_authentication: Annotated[str, Strict(strict=True)])¶

Bases: Secret

A model object representing the Oauth2Secret resource.

Constructs an object of type Oauth2Secret with the provided properties.

Parameters:

  • name (str) – Name of the secret

  • api_authentication (str) – API provider’s authentication server integration name

  • comment (str, optional) – user comment associated to an object in the dictionary

  • created_on (datetime, optional) – Date and time when the secret was created.

  • database_name (str, optional) – Database in which the secret is stored

  • schema_name (str, optional) – Schema in which the secret is stored

  • owner (str, optional) – Role that owns the secret

  • owner_role_type (str, optional) – The type of role that owns the secret

  • oauth_refresh_token (str, optional) – OAuth secret refresh token

  • oauth_refresh_token_expiry_time (str, optional) – Date or timestamp (UTC) when OAuth refresh token will expire. Possible formats: YYYY-MM-DD, YYYY-MM-DD HH24:MI:SS

  • oauth_scopes (list[str], optional) – Scopes represented during OAuth Flow

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) → Oauth2Secret¶

Create an instance of Oauth2Secret from a dict.

classmethod from_json(json_str: str) → Oauth2Secret¶

Create an instance of Oauth2Secret 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