Skip to content

AuthProviderSpec.md

Latest commit

 

History

History
49 lines (40 loc) · 3.58 KB

AuthProviderSpec.md

File metadata and controls

49 lines (40 loc) · 3.58 KB
Raw

AuthProviderSpec

Properties

Name Type Description Notes
provider_type str The type of authentication provider.
display_name str Human-readable display name for the provider. [optional]
issuer str The OAuth2 issuer identifier (used for issuer identification in tokens).
client_id str The OAuth2 client ID.
client_secret str The OAuth2 client secret.
enabled bool Whether this K8s provider is enabled. [optional] [default to True]
scopes List[str] List of OAuth2 scopes to request.
prompt str Space-separated, case-sensitive authorization prompt values, such as login, consent, select_account, none, or provider-specific values. Omitted and null values are preserved in AuthProvider resources and exposed as select_account in public authentication configuration. An empty string instructs clients to omit the prompt parameter. Values must be printable ASCII separated by spaces; none cannot accompany a different value. Accepted values are preserved, including extra spaces and duplicates. [optional]
organization_assignment AuthOrganizationAssignment
username_claim List[str] JSON path to the username claim in the userinfo response as an array of path segments (e.g., ["preferred_username"], ["email"], ["sub"]). [optional] [default to [preferred_username]]
role_assignment AuthRoleAssignment
authorization_url str The OAuth2 authorization endpoint URL.
token_url str The OAuth2 token endpoint URL.
userinfo_url str The OAuth2 userinfo endpoint URL.
introspection OAuth2Introspection [optional]
cluster_control_plane_url str The OpenShift cluster control plane URL. [optional]
project_label_filter str If specified, only projects with this label will be considered. The label selector should be in the format 'key' or 'key=value'. If only the key is provided, any project with that label (regardless of value) will be included. This enables server-side filtering for better performance. [optional]
role_suffix str Optional suffix to strip from ClusterRole names when normalizing role names. Used for multi-release deployments where ClusterRoles have namespace-specific names (e.g., flightctl-admin-<namespace>). [optional]
organization_name_prefix str Optional prefix for the organization name. The default org name is exposed as prefix + 'default' when set. [optional]
api_url str The internal Kubernetes API URL.
rbac_ns str The RBAC namespace for permissions. [optional]

Example

from flightctl.models.auth_provider_spec import AuthProviderSpec

# TODO update the JSON string below
json = "{}"
# create an instance of AuthProviderSpec from a JSON string
auth_provider_spec_instance = AuthProviderSpec.from_json(json)
# print the JSON string representation of the object
print(AuthProviderSpec.to_json())

# convert the object into a dict
auth_provider_spec_dict = auth_provider_spec_instance.to_dict()
# create an instance of AuthProviderSpec from a dict
auth_provider_spec_from_dict = AuthProviderSpec.from_dict(auth_provider_spec_dict)

[Back to Model list] [Back to API list] [Back to README]