Skip to content

[bot] add DOKS SSO fields: Re-Generated From digitalocean/openapi@6fd6c99 #657

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RohithSangati merged 1 commit into from
May 20, 2026
Merged

[bot] add DOKS SSO fields: Re-Generated From digitalocean/openapi@6fd6c99 #657

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DO_OPENAPI_COMMIT_SHA.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
a1cee6c
6fd6c99
161 changes: 158 additions & 3 deletions src/pydo/aio/operations/_operations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149330,6 +149330,19 @@ async def list_clusters(
"service_subnet": "str", # Optional. The range of assignable
IP addresses for services running in the Kubernetes cluster in CIDR
notation.
"sso": {
"client_id": "str", # Optional. The OIDC client ID
registered with the identity provider. Required when ``enabled`` is
``true``.
"enabled": False, # Optional. Default value is
False. Indicates whether SSO authentication is enabled for the
cluster.
"issuer_url": "str", # Optional. The OIDC issuer URL
for the identity provider. Required when ``enabled`` is ``true``.
"required": False # Optional. Default value is
False. Indicates whether any non-SSO forms of authentication are
disallowed. Can only be set to ``true`` when ``enabled`` is ``true``.
},
"status": {
"message": "str", # Optional. An optional message
providing additional information about the current cluster state.
Expand Down Expand Up @@ -149617,6 +149630,17 @@ async def create_cluster(
},
"service_subnet": "str", # Optional. The range of assignable IP addresses
for services running in the Kubernetes cluster in CIDR notation.
"sso": {
"client_id": "str", # Optional. The OIDC client ID registered with
the identity provider. Required when ``enabled`` is ``true``.
"enabled": False, # Optional. Default value is False. Indicates
whether SSO authentication is enabled for the cluster.
"issuer_url": "str", # Optional. The OIDC issuer URL for the
identity provider. Required when ``enabled`` is ``true``.
"required": False # Optional. Default value is False. Indicates
whether any non-SSO forms of authentication are disallowed. Can only be set
to ``true`` when ``enabled`` is ``true``.
},
"status": {
"message": "str", # Optional. An optional message providing
additional information about the current cluster state.
Expand Down Expand Up @@ -149817,6 +149841,18 @@ async def create_cluster(
},
"service_subnet": "str", # Optional. The range of assignable IP
addresses for services running in the Kubernetes cluster in CIDR notation.
"sso": {
"client_id": "str", # Optional. The OIDC client ID
registered with the identity provider. Required when ``enabled`` is
``true``.
"enabled": False, # Optional. Default value is False.
Indicates whether SSO authentication is enabled for the cluster.
"issuer_url": "str", # Optional. The OIDC issuer URL for the
identity provider. Required when ``enabled`` is ``true``.
"required": False # Optional. Default value is False.
Indicates whether any non-SSO forms of authentication are disallowed. Can
only be set to ``true`` when ``enabled`` is ``true``.
},
"status": {
"message": "str", # Optional. An optional message providing
additional information about the current cluster state.
Expand Down Expand Up @@ -150048,6 +150084,18 @@ async def create_cluster(
},
"service_subnet": "str", # Optional. The range of assignable IP
addresses for services running in the Kubernetes cluster in CIDR notation.
"sso": {
"client_id": "str", # Optional. The OIDC client ID
registered with the identity provider. Required when ``enabled`` is
``true``.
"enabled": False, # Optional. Default value is False.
Indicates whether SSO authentication is enabled for the cluster.
"issuer_url": "str", # Optional. The OIDC issuer URL for the
identity provider. Required when ``enabled`` is ``true``.
"required": False # Optional. Default value is False.
Indicates whether any non-SSO forms of authentication are disallowed. Can
only be set to ``true`` when ``enabled`` is ``true``.
},
"status": {
"message": "str", # Optional. An optional message providing
additional information about the current cluster state.
Expand Down Expand Up @@ -150265,6 +150313,17 @@ async def create_cluster(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> J
},
"service_subnet": "str", # Optional. The range of assignable IP addresses
for services running in the Kubernetes cluster in CIDR notation.
"sso": {
"client_id": "str", # Optional. The OIDC client ID registered with
the identity provider. Required when ``enabled`` is ``true``.
"enabled": False, # Optional. Default value is False. Indicates
whether SSO authentication is enabled for the cluster.
"issuer_url": "str", # Optional. The OIDC issuer URL for the
identity provider. Required when ``enabled`` is ``true``.
"required": False # Optional. Default value is False. Indicates
whether any non-SSO forms of authentication are disallowed. Can only be set
to ``true`` when ``enabled`` is ``true``.
},
"status": {
"message": "str", # Optional. An optional message providing
additional information about the current cluster state.
Expand Down Expand Up @@ -150465,6 +150524,18 @@ async def create_cluster(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> J
},
"service_subnet": "str", # Optional. The range of assignable IP
addresses for services running in the Kubernetes cluster in CIDR notation.
"sso": {
"client_id": "str", # Optional. The OIDC client ID
registered with the identity provider. Required when ``enabled`` is
``true``.
"enabled": False, # Optional. Default value is False.
Indicates whether SSO authentication is enabled for the cluster.
"issuer_url": "str", # Optional. The OIDC issuer URL for the
identity provider. Required when ``enabled`` is ``true``.
"required": False # Optional. Default value is False.
Indicates whether any non-SSO forms of authentication are disallowed. Can
only be set to ``true`` when ``enabled`` is ``true``.
},
"status": {
"message": "str", # Optional. An optional message providing
additional information about the current cluster state.
Expand Down Expand Up @@ -150760,6 +150831,18 @@ async def get_cluster(self, cluster_id: str, **kwargs: Any) -> JSON:
},
"service_subnet": "str", # Optional. The range of assignable IP
addresses for services running in the Kubernetes cluster in CIDR notation.
"sso": {
"client_id": "str", # Optional. The OIDC client ID
registered with the identity provider. Required when ``enabled`` is
``true``.
"enabled": False, # Optional. Default value is False.
Indicates whether SSO authentication is enabled for the cluster.
"issuer_url": "str", # Optional. The OIDC issuer URL for the
identity provider. Required when ``enabled`` is ``true``.
"required": False # Optional. Default value is False.
Indicates whether any non-SSO forms of authentication are disallowed. Can
only be set to ``true`` when ``enabled`` is ``true``.
},
"status": {
"message": "str", # Optional. An optional message providing
additional information about the current cluster state.
Expand Down Expand Up @@ -150976,6 +151059,17 @@ async def update_cluster(
"enabled": bool # Optional. Indicates whether the routing-agent
component is enabled.
},
"sso": {
"client_id": "str", # Optional. The OIDC client ID registered with
the identity provider. Required when ``enabled`` is ``true``.
"enabled": False, # Optional. Default value is False. Indicates
whether SSO authentication is enabled for the cluster.
"issuer_url": "str", # Optional. The OIDC issuer URL for the
identity provider. Required when ``enabled`` is ``true``.
"required": False # Optional. Default value is False. Indicates
whether any non-SSO forms of authentication are disallowed. Can only be set
to ``true`` when ``enabled`` is ``true``.
},
"surge_upgrade": False, # Optional. Default value is False. A boolean value
indicating whether surge upgrade is enabled/disabled for the cluster. Surge
upgrade makes cluster upgrades fast and reliable by bringing up new nodes before
Expand Down Expand Up @@ -151161,6 +151255,18 @@ async def update_cluster(
},
"service_subnet": "str", # Optional. The range of assignable IP
addresses for services running in the Kubernetes cluster in CIDR notation.
"sso": {
"client_id": "str", # Optional. The OIDC client ID
registered with the identity provider. Required when ``enabled`` is
``true``.
"enabled": False, # Optional. Default value is False.
Indicates whether SSO authentication is enabled for the cluster.
"issuer_url": "str", # Optional. The OIDC issuer URL for the
identity provider. Required when ``enabled`` is ``true``.
"required": False # Optional. Default value is False.
Indicates whether any non-SSO forms of authentication are disallowed. Can
only be set to ``true`` when ``enabled`` is ``true``.
},
"status": {
"message": "str", # Optional. An optional message providing
additional information about the current cluster state.
Expand Down Expand Up @@ -151404,6 +151510,18 @@ async def update_cluster(
},
"service_subnet": "str", # Optional. The range of assignable IP
addresses for services running in the Kubernetes cluster in CIDR notation.
"sso": {
"client_id": "str", # Optional. The OIDC client ID
registered with the identity provider. Required when ``enabled`` is
``true``.
"enabled": False, # Optional. Default value is False.
Indicates whether SSO authentication is enabled for the cluster.
"issuer_url": "str", # Optional. The OIDC issuer URL for the
identity provider. Required when ``enabled`` is ``true``.
"required": False # Optional. Default value is False.
Indicates whether any non-SSO forms of authentication are disallowed. Can
only be set to ``true`` when ``enabled`` is ``true``.
},
"status": {
"message": "str", # Optional. An optional message providing
additional information about the current cluster state.
Expand Down Expand Up @@ -151536,6 +151654,17 @@ async def update_cluster(
"enabled": bool # Optional. Indicates whether the routing-agent
component is enabled.
},
"sso": {
"client_id": "str", # Optional. The OIDC client ID registered with
the identity provider. Required when ``enabled`` is ``true``.
"enabled": False, # Optional. Default value is False. Indicates
whether SSO authentication is enabled for the cluster.
"issuer_url": "str", # Optional. The OIDC issuer URL for the
identity provider. Required when ``enabled`` is ``true``.
"required": False # Optional. Default value is False. Indicates
whether any non-SSO forms of authentication are disallowed. Can only be set
to ``true`` when ``enabled`` is ``true``.
},
"surge_upgrade": False, # Optional. Default value is False. A boolean value
indicating whether surge upgrade is enabled/disabled for the cluster. Surge
upgrade makes cluster upgrades fast and reliable by bringing up new nodes before
Expand Down Expand Up @@ -151721,6 +151850,18 @@ async def update_cluster(
},
"service_subnet": "str", # Optional. The range of assignable IP
addresses for services running in the Kubernetes cluster in CIDR notation.
"sso": {
"client_id": "str", # Optional. The OIDC client ID
registered with the identity provider. Required when ``enabled`` is
``true``.
"enabled": False, # Optional. Default value is False.
Indicates whether SSO authentication is enabled for the cluster.
"issuer_url": "str", # Optional. The OIDC issuer URL for the
identity provider. Required when ``enabled`` is ``true``.
"required": False # Optional. Default value is False.
Indicates whether any non-SSO forms of authentication are disallowed. Can
only be set to ``true`` when ``enabled`` is ``true``.
},
"status": {
"message": "str", # Optional. An optional message providing
additional information about the current cluster state.
Expand Down Expand Up @@ -152465,7 +152606,12 @@ async def destroy_associated_resources_dangerous(

@distributed_trace_async
async def get_kubeconfig(
self, cluster_id: str, *, expiry_seconds: int = 0, **kwargs: Any
self,
cluster_id: str,
*,
expiry_seconds: int = 0,
type: Optional[str] = None,
**kwargs: Any
) -> Optional[JSON]:
# pylint: disable=line-too-long
"""Retrieve the kubeconfig for a Kubernetes Cluster.
Expand All @@ -152487,9 +152633,12 @@ async def get_kubeconfig(
passing a duration in seconds as a query parameter to
``/v2/kubernetes/clusters/$K8S_CLUSTER_ID/kubeconfig?expiry_seconds=$DURATION_IN_SECONDS``.
If not set or 0, then the token will have a 7 day expiry. The query parameter
has no impact in certificate-based authentication.
has no impact for other kubeconfig types.

Using an ``sso`` kubeconfig type requires ``doctl`` to be installed to handle the client side
of the OAuth2 flow.

Kubernetes Roles granted to a user with a token-based kubeconfig are derived from that user's
Kubernetes Roles granted to a user are derived from that user's
DigitalOcean role. Predefined roles (Owner, Member, Modifier etc.) have an automatic mapping
to Kubernetes roles. Custom roles are not automatically mapped to any Kubernetes roles,
and require `additional configuration
Expand All @@ -152501,6 +152650,11 @@ async def get_kubeconfig(
:keyword expiry_seconds: The duration in seconds that the returned Kubernetes credentials will
be valid. If not set or 0, the credentials will have a 7 day expiry. Default value is 0.
:paramtype expiry_seconds: int
:keyword type: The type of credentials to return in the kubeconfig. When omitted, the
default credential type for the cluster is used: ``sso`` for clusters with SSO enabled,
``token`` for clusters without SSO enabled. Known values are: "token" and "sso". Default value
is None.
:paramtype type: str
:return: JSON object or None
:rtype: JSON or None
:raises ~azure.core.exceptions.HttpResponseError:
Expand Down Expand Up @@ -152541,6 +152695,7 @@ async def get_kubeconfig(
_request = build_kubernetes_get_kubeconfig_request(
cluster_id=cluster_id,
expiry_seconds=expiry_seconds,
type=type,
headers=_headers,
params=_params,
)
Expand Down
Loading
Loading