com.google.api.services.serviceusage.v1beta1.model.AuthProvider Maven / Gradle / Ivy
/*
* Copyright 2010 Google Inc.
*
* 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://code.google.com/p/google-apis-client-generator/
* (build: 2018-05-04 17:28:03 UTC)
* on 2018-06-23 at 13:17:02 UTC
* Modify at your own risk.
*/
package com.google.api.services.serviceusage.v1beta1.model;
/**
* Configuration for an anthentication provider, including support for [JSON Web Token
* (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
*
* 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 Service Usage API. For a detailed explanation see:
* http://code.google.com/p/google-http-java-client/wiki/JSON
*
*
* @author Google, Inc.
*/
@SuppressWarnings("javadoc")
public final class AuthProvider extends com.google.api.client.json.GenericJson {
/**
* The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-
* token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences
* will be accepted. When this setting is absent, only JWTs with audience
* "https://Service_name/API_name" will be accepted. For example, if no audiences are in the
* setting, LibraryService API will only accept JWTs with the following audience "https://library-
* example.googleapis.com/google.example.library.v1.LibraryService".
*
* Example:
*
* audiences: bookstore_android.apps.googleusercontent.com,
* bookstore_web.apps.googleusercontent.com
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String audiences;
/**
* Redirect URL if JWT token is required but no present or is expired. Implement authorizationUrl
* of securityDefinitions in OpenAPI spec.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String authorizationUrl;
/**
* The unique identifier of the auth provider. It will be referred to by
* `AuthRequirement.provider_id`.
*
* Example: "bookstore_auth".
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String id;
/**
* Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-
* json-web-token-32#section-4.1.1 Usually a URL or an email address.
*
* Example: https://securetoken.google.com Example: [email protected]
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String issuer;
/**
* URL of the provider's public key set to validate signature of the JWT. See [OpenID
* Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).
* Optional if the key set document: - can be retrieved from [OpenID
* Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of the issuer. - can
* be inferred from the email domain of the issuer (e.g. a Google service account).
*
* Example: https://www.googleapis.com/oauth2/v1/certs
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String jwksUri;
/**
* The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-
* token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences
* will be accepted. When this setting is absent, only JWTs with audience
* "https://Service_name/API_name" will be accepted. For example, if no audiences are in the
* setting, LibraryService API will only accept JWTs with the following audience "https://library-
* example.googleapis.com/google.example.library.v1.LibraryService".
*
* Example:
*
* audiences: bookstore_android.apps.googleusercontent.com,
* bookstore_web.apps.googleusercontent.com
* @return value or {@code null} for none
*/
public java.lang.String getAudiences() {
return audiences;
}
/**
* The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-
* token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences
* will be accepted. When this setting is absent, only JWTs with audience
* "https://Service_name/API_name" will be accepted. For example, if no audiences are in the
* setting, LibraryService API will only accept JWTs with the following audience "https://library-
* example.googleapis.com/google.example.library.v1.LibraryService".
*
* Example:
*
* audiences: bookstore_android.apps.googleusercontent.com,
* bookstore_web.apps.googleusercontent.com
* @param audiences audiences or {@code null} for none
*/
public AuthProvider setAudiences(java.lang.String audiences) {
this.audiences = audiences;
return this;
}
/**
* Redirect URL if JWT token is required but no present or is expired. Implement authorizationUrl
* of securityDefinitions in OpenAPI spec.
* @return value or {@code null} for none
*/
public java.lang.String getAuthorizationUrl() {
return authorizationUrl;
}
/**
* Redirect URL if JWT token is required but no present or is expired. Implement authorizationUrl
* of securityDefinitions in OpenAPI spec.
* @param authorizationUrl authorizationUrl or {@code null} for none
*/
public AuthProvider setAuthorizationUrl(java.lang.String authorizationUrl) {
this.authorizationUrl = authorizationUrl;
return this;
}
/**
* The unique identifier of the auth provider. It will be referred to by
* `AuthRequirement.provider_id`.
*
* Example: "bookstore_auth".
* @return value or {@code null} for none
*/
public java.lang.String getId() {
return id;
}
/**
* The unique identifier of the auth provider. It will be referred to by
* `AuthRequirement.provider_id`.
*
* Example: "bookstore_auth".
* @param id id or {@code null} for none
*/
public AuthProvider setId(java.lang.String id) {
this.id = id;
return this;
}
/**
* Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-
* json-web-token-32#section-4.1.1 Usually a URL or an email address.
*
* Example: https://securetoken.google.com Example: [email protected]
* @return value or {@code null} for none
*/
public java.lang.String getIssuer() {
return issuer;
}
/**
* Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-
* json-web-token-32#section-4.1.1 Usually a URL or an email address.
*
* Example: https://securetoken.google.com Example: [email protected]
* @param issuer issuer or {@code null} for none
*/
public AuthProvider setIssuer(java.lang.String issuer) {
this.issuer = issuer;
return this;
}
/**
* URL of the provider's public key set to validate signature of the JWT. See [OpenID
* Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).
* Optional if the key set document: - can be retrieved from [OpenID
* Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of the issuer. - can
* be inferred from the email domain of the issuer (e.g. a Google service account).
*
* Example: https://www.googleapis.com/oauth2/v1/certs
* @return value or {@code null} for none
*/
public java.lang.String getJwksUri() {
return jwksUri;
}
/**
* URL of the provider's public key set to validate signature of the JWT. See [OpenID
* Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).
* Optional if the key set document: - can be retrieved from [OpenID
* Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of the issuer. - can
* be inferred from the email domain of the issuer (e.g. a Google service account).
*
* Example: https://www.googleapis.com/oauth2/v1/certs
* @param jwksUri jwksUri or {@code null} for none
*/
public AuthProvider setJwksUri(java.lang.String jwksUri) {
this.jwksUri = jwksUri;
return this;
}
@Override
public AuthProvider set(String fieldName, Object value) {
return (AuthProvider) super.set(fieldName, value);
}
@Override
public AuthProvider clone() {
return (AuthProvider) super.clone();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy