Struct OAuthClient

pub struct OAuthClient {
    pub access_token_inactivity_timeout_seconds: Option<i32>,
    pub access_token_max_age_seconds: Option<i32>,
    pub additional_secrets: Option<Vec<String>>,
    pub grant_method: Option<String>,
    pub metadata: ObjectMeta,
    pub redirect_ur_is: Option<Vec<String>>,
    pub respond_with_challenges: Option<bool>,
    pub scope_restrictions: Option<Vec<ScopeRestriction>>,
    pub secret: Option<String>,
}

OAuthClient describes an OAuth client

Fields

access_token_inactivity_timeout_seconds: Option<i32>

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)

access_token_max_age_seconds: Option<i32>

AccessTokenMaxAgeSeconds overrides the default access token max age for tokens granted to this client. 0 means no expiration.

additional_secrets: Option<Vec<String>>

AdditionalSecrets holds other secrets that may be used to identify the client. This is useful for rotation and for service account token validation

grant_method: Option<String>

GrantMethod determines how to handle grants for this client. If no method is provided, the cluster default grant handling method will be used. 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
• deny: always denies grant requests, useful for black-listed clients

metadata: ObjectMeta

Standard object’s metadata.

redirect_ur_is: Option<Vec<String>>

RedirectURIs is the valid redirection URIs associated with a client

respond_with_challenges: Option<bool>

RespondWithChallenges indicates whether the client wants authentication needed responses made in the form of challenges instead of redirects

scope_restrictions: Option<Vec<ScopeRestriction>>

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.

secret: Option<String>

Secret is the unique secret associated with a client

Implementations

impl OAuthClient

pub fn create_o_auth_client( body: &OAuthClient, optional: CreateOptional<'_>, ) -> Result<(Request<Vec<u8>>, fn(StatusCode) -> ResponseBody<CreateResponse<Self>>), RequestError>

create an OAuthClient

Use the returned k8s_openapi::ResponseBody<k8s_openapi::CreateResponse<Self>> constructor, or k8s_openapi::CreateResponse<Self> directly, to parse the HTTP response.

Arguments

• body

• optional

  Optional parameters. Use Default::default() to not pass any.

impl OAuthClient

pub fn delete_collection_o_auth_client( delete_optional: DeleteOptional<'_>, list_optional: ListOptional<'_>, ) -> Result<(Request<Vec<u8>>, fn(StatusCode) -> ResponseBody<DeleteResponse<List<Self>>>), RequestError>

delete collection of OAuthClient

Use the returned k8s_openapi::ResponseBody<k8s_openapi::DeleteResponse<k8s_openapi::List<Self>>> constructor, or k8s_openapi::DeleteResponse<k8s_openapi::List<Self>> directly, to parse the HTTP response.

Arguments

• delete_optional

  Delete options. Use Default::default() to not pass any.

• list_optional

  List options. Use Default::default() to not pass any.

impl OAuthClient

pub fn delete_o_auth_client( name: &str, optional: DeleteOptional<'_>, ) -> Result<(Request<Vec<u8>>, fn(StatusCode) -> ResponseBody<DeleteResponse<Self>>), RequestError>

delete an OAuthClient

Use the returned k8s_openapi::ResponseBody<k8s_openapi::DeleteResponse<Self>> constructor, or k8s_openapi::DeleteResponse<Self> directly, to parse the HTTP response.

Arguments

• name

  name of the OAuthClient

• optional

  Optional parameters. Use Default::default() to not pass any.

impl OAuthClient

pub fn list_o_auth_client( optional: ListOptional<'_>, ) -> Result<(Request<Vec<u8>>, fn(StatusCode) -> ResponseBody<ListResponse<Self>>), RequestError>

list or watch objects of kind OAuthClient

This operation only supports listing all items of this type.

Use the returned k8s_openapi::ResponseBody<k8s_openapi::ListResponse<Self>> constructor, or k8s_openapi::ListResponse<Self> directly, to parse the HTTP response.

Arguments

• optional

  Optional parameters. Use Default::default() to not pass any.

impl OAuthClient

pub fn patch_o_auth_client( name: &str, body: &Patch, optional: PatchOptional<'_>, ) -> Result<(Request<Vec<u8>>, fn(StatusCode) -> ResponseBody<PatchResponse<Self>>), RequestError>

partially update the specified OAuthClient

Use the returned k8s_openapi::ResponseBody<k8s_openapi::PatchResponse<Self>> constructor, or k8s_openapi::PatchResponse<Self> directly, to parse the HTTP response.

Arguments

• name

  name of the OAuthClient

• body

• optional

  Optional parameters. Use Default::default() to not pass any.

impl OAuthClient

pub fn read_o_auth_client( name: &str, optional: ReadOAuthClientOptional<'_>, ) -> Result<(Request<Vec<u8>>, fn(StatusCode) -> ResponseBody<ReadOAuthClientResponse>), RequestError>

read the specified OAuthClient

Use the returned k8s_openapi::ResponseBody<ReadOAuthClientResponse> constructor, or ReadOAuthClientResponse directly, to parse the HTTP response.

Arguments

• name

  name of the OAuthClient

• optional

  Optional parameters. Use Default::default() to not pass any.

impl OAuthClient

pub fn replace_o_auth_client( name: &str, body: &OAuthClient, optional: ReplaceOptional<'_>, ) -> Result<(Request<Vec<u8>>, fn(StatusCode) -> ResponseBody<ReplaceResponse<Self>>), RequestError>

replace the specified OAuthClient

Use the returned k8s_openapi::ResponseBody<k8s_openapi::ReplaceResponse<Self>> constructor, or k8s_openapi::ReplaceResponse<Self> directly, to parse the HTTP response.

Arguments

• name

  name of the OAuthClient

• body

• optional

  Optional parameters. Use Default::default() to not pass any.

impl OAuthClient

pub fn watch_o_auth_client( optional: WatchOptional<'_>, ) -> Result<(Request<Vec<u8>>, fn(StatusCode) -> ResponseBody<WatchResponse<Self>>), RequestError>

list or watch objects of kind OAuthClient

This operation only supports watching one item, or a list of items, of this type for changes.

Use the returned k8s_openapi::ResponseBody<k8s_openapi::WatchResponse<Self>> constructor, or k8s_openapi::WatchResponse<Self> directly, to parse the HTTP response.

Arguments

• optional

  Optional parameters. Use Default::default() to not pass any.

Trait Implementations

impl Clone for OAuthClient

fn clone(&self) -> OAuthClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OAuthClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for OAuthClient

fn default() -> OAuthClient

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OAuthClient

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl ListableResource for OAuthClient

const LIST_KIND: &'static str = "OAuthClientList"

The kind of the list type of the resource.

impl Metadata for OAuthClient

type Ty = ObjectMeta

The type of the metadata object.

fn metadata(&self) -> &<Self as Metadata>::Ty

Gets a reference to the metadata of this resource value.

fn metadata_mut(&mut self) -> &mut <Self as Metadata>::Ty

Gets a mutable reference to the metadata of this resource value.

impl PartialEq for OAuthClient

fn eq(&self, other: &OAuthClient) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Resource for OAuthClient

const API_VERSION: &'static str = "oauth.openshift.io/v1"

The API version of the resource. This is a composite of Resource::GROUP and Resource::VERSION (eg "apiextensions.k8s.io/v1beta1") or just the version for resources without a group (eg "v1").

const GROUP: &'static str = "oauth.openshift.io"

The group of the resource, or the empty string if the resource doesn’t have a group.

const KIND: &'static str = "OAuthClient"

The kind of the resource.

const VERSION: &'static str = "v1"

The version of the resource.

impl Serialize for OAuthClient

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OAuthClient