com.google.api.services.iap.v1.model.OAuthSettings Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-iap Show documentation
There is a newer version: v1-rev20240909-2.0.0
Show newest version
/*
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
/*
 * This code was generated by https://github.com/googleapis/google-api-java-client-services/
 * Modify at your own risk.
 */

package com.google.api.services.iap.v1.model;

/**
 * Configuration for OAuth login&consent flow behavior as well as for OAuth Credentials.
 *
 *  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 * transmitted over HTTP when working with the Cloud Identity-Aware Proxy API. For a detailed
 * explanation see:
 * https://developers.google.com/api-client-library/java/google-http-java-client/json
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class OAuthSettings extends com.google.api.client.json.GenericJson {

  /**
   * Domain hint to send as hd=? parameter in OAuth request flow. Enables redirect to primary IDP by
   * skipping Google's login screen.
   * https://developers.google.com/identity/protocols/OpenIDConnect#hd-param Note: IAP does not
   * verify that the id token's hd claim matches this value since access behavior is managed by IAM
   * policies.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String loginHint;

  /**
   * Optional. List of client ids allowed to use IAP programmatically.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List programmaticClients;

  /**
   * Domain hint to send as hd=? parameter in OAuth request flow. Enables redirect to primary IDP by
   * skipping Google's login screen.
   * https://developers.google.com/identity/protocols/OpenIDConnect#hd-param Note: IAP does not
   * verify that the id token's hd claim matches this value since access behavior is managed by IAM
   * policies.
   * @return value or {@code null} for none
   */
  public java.lang.String getLoginHint() {
    return loginHint;
  }

  /**
   * Domain hint to send as hd=? parameter in OAuth request flow. Enables redirect to primary IDP by
   * skipping Google's login screen.
   * https://developers.google.com/identity/protocols/OpenIDConnect#hd-param Note: IAP does not
   * verify that the id token's hd claim matches this value since access behavior is managed by IAM
   * policies.
   * @param loginHint loginHint or {@code null} for none
   */
  public OAuthSettings setLoginHint(java.lang.String loginHint) {
    this.loginHint = loginHint;
    return this;
  }

  /**
   * Optional. List of client ids allowed to use IAP programmatically.
   * @return value or {@code null} for none
   */
  public java.util.List getProgrammaticClients() {
    return programmaticClients;
  }

  /**
   * Optional. List of client ids allowed to use IAP programmatically.
   * @param programmaticClients programmaticClients or {@code null} for none
   */
  public OAuthSettings setProgrammaticClients(java.util.List programmaticClients) {
    this.programmaticClients = programmaticClients;
    return this;
  }

  @Override
  public OAuthSettings set(String fieldName, Object value) {
    return (OAuthSettings) super.set(fieldName, value);
  }

  @Override
  public OAuthSettings clone() {
    return (OAuthSettings) super.clone();
  }

}