Package io.fabric8.openshift.api.model

Class OAuthClient

  • All Implemented Interfaces:
    io.fabric8.kubernetes.api.builder.Editable<OAuthClientBuilder>, io.fabric8.kubernetes.api.model.HasMetadata, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable
    @Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class OAuthClient
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<OAuthClientBuilder>, io.fabric8.kubernetes.api.model.HasMetadata
    OAuthClient describes an OAuth client


    Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

    See Also:
    Serialized Form

    • Constructor Detail

      • OAuthClient

        public OAuthClient()
        No args constructor for use in serialization

    • Method Detail

      • getAccessTokenInactivityTimeoutSeconds

        public Integer getAccessTokenInactivityTimeoutSeconds()
        accessTokenInactivityTimeoutSeconds overrides the default token inactivity timeout for tokens granted to this client. The value represents the maximum amount of time that can occur between consecutive uses of the token. Tokens become invalid if they are not used within this temporal window. The user will need to acquire a new token to regain access once a token times out. This value needs to be set only if the default set in configuration is not appropriate for this client. Valid values are: - 0: Tokens for this client never time out - X: Tokens time out if there is no activity for X seconds The current minimum allowed value for X is 300 (5 minutes)


        WARNING: existing tokens' timeout will not be affected (lowered) by changing this value

      • setAccessTokenInactivityTimeoutSeconds

        public void setAccessTokenInactivityTimeoutSeconds​(Integer accessTokenInactivityTimeoutSeconds)
        accessTokenInactivityTimeoutSeconds overrides the default token inactivity timeout for tokens granted to this client. The value represents the maximum amount of time that can occur between consecutive uses of the token. Tokens become invalid if they are not used within this temporal window. The user will need to acquire a new token to regain access once a token times out. This value needs to be set only if the default set in configuration is not appropriate for this client. Valid values are: - 0: Tokens for this client never time out - X: Tokens time out if there is no activity for X seconds The current minimum allowed value for X is 300 (5 minutes)


        WARNING: existing tokens' timeout will not be affected (lowered) by changing this value

      • getAccessTokenMaxAgeSeconds

        public Integer getAccessTokenMaxAgeSeconds()
        accessTokenMaxAgeSeconds overrides the default access token max age for tokens granted to this client. 0 means no expiration.

      • setAccessTokenMaxAgeSeconds

        public void setAccessTokenMaxAgeSeconds​(Integer accessTokenMaxAgeSeconds)
        accessTokenMaxAgeSeconds overrides the default access token max age for tokens granted to this client. 0 means no expiration.

      • getAdditionalSecrets

        public List<String> getAdditionalSecrets()
        additionalSecrets holds other secrets that may be used to identify the client. This is useful for rotation and for service account token validation

      • setAdditionalSecrets

        public void setAdditionalSecrets​(List<String> additionalSecrets)
        additionalSecrets holds other secrets that may be used to identify the client. This is useful for rotation and for service account token validation

      • getApiVersion

        public String getApiVersion()
        APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
        Specified by:
        getApiVersion in interface io.fabric8.kubernetes.api.model.HasMetadata

      • setApiVersion

        public void setApiVersion​(String apiVersion)
        APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
        Specified by:
        setApiVersion in interface io.fabric8.kubernetes.api.model.HasMetadata

      • getGrantMethod

        public String getGrantMethod()
        grantMethod is a required field which determines how to handle grants for this client. Valid grant handling methods are:

        - auto: always approves grant requests, useful for trusted clients

        - prompt: prompts the end user for approval of grant requests, useful for third-party clients

      • setGrantMethod

        public void setGrantMethod​(String grantMethod)
        grantMethod is a required field which determines how to handle grants for this client. Valid grant handling methods are:

        - auto: always approves grant requests, useful for trusted clients

        - prompt: prompts the end user for approval of grant requests, useful for third-party clients

      • getKind

        public String getKind()
        Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
        Specified by:
        getKind in interface io.fabric8.kubernetes.api.model.HasMetadata

      • setKind

        public void setKind​(String kind)
        Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

      • getMetadata

        public io.fabric8.kubernetes.api.model.ObjectMeta getMetadata()
        OAuthClient describes an OAuth client


        Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

        Specified by:
        getMetadata in interface io.fabric8.kubernetes.api.model.HasMetadata

      • setMetadata

        public void setMetadata​(io.fabric8.kubernetes.api.model.ObjectMeta metadata)
        OAuthClient describes an OAuth client


        Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

        Specified by:
        setMetadata in interface io.fabric8.kubernetes.api.model.HasMetadata

      • getRedirectURIs

        public List<String> getRedirectURIs()
        redirectURIs is the valid redirection URIs associated with a client

      • setRedirectURIs

        public void setRedirectURIs​(List<String> redirectURIs)
        redirectURIs is the valid redirection URIs associated with a client

      • getRespondWithChallenges

        public Boolean getRespondWithChallenges()
        respondWithChallenges indicates whether the client wants authentication needed responses made in the form of challenges instead of redirects

      • setRespondWithChallenges

        public void setRespondWithChallenges​(Boolean respondWithChallenges)
        respondWithChallenges indicates whether the client wants authentication needed responses made in the form of challenges instead of redirects

      • getScopeRestrictions

        public List<ScopeRestriction> getScopeRestrictions()
        scopeRestrictions describes which scopes this client can request. Each requested scope is checked against each restriction. If any restriction matches, then the scope is allowed. If no restriction matches, then the scope is denied.

      • setScopeRestrictions

        public void setScopeRestrictions​(List<ScopeRestriction> scopeRestrictions)
        scopeRestrictions describes which scopes this client can request. Each requested scope is checked against each restriction. If any restriction matches, then the scope is allowed. If no restriction matches, then the scope is denied.

      • getSecret

        public String getSecret()
        secret is the unique secret associated with a client

      • setSecret

        public void setSecret​(String secret)
        secret is the unique secret associated with a client

      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()

      • setAdditionalProperty

        public void setAdditionalProperty​(String name,
                                  Object value)

      • setAdditionalProperties

        public void setAdditionalProperties​(Map<String,​Object> additionalProperties)