All Downloads are FREE. Search and download functionalities are using the official Maven repository.

target.apidocs.com.google.api.services.servicemanagement.model.AuthRequirement.html Maven / Gradle / Ivy

There is a newer version: v1-rev20241106-2.0.0
Show newest version






AuthRequirement (Service Management API v1-rev20240823-2.0.0)












com.google.api.services.servicemanagement.model

Class AuthRequirement

  • All Implemented Interfaces:
    Cloneable, Map<String,Object>


    public final class AuthRequirement
    extends com.google.api.client.json.GenericJson
    User-defined authentication requirements, 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 Management API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

    Author:
    Google, Inc.
    • Constructor Detail

      • AuthRequirement

        public AuthRequirement()
    • Method Detail

      • getAudiences

        public String getAudiences()
        NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. 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
        Returns:
        value or null for none
      • setAudiences

        public AuthRequirement setAudiences(String audiences)
        NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. 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
        Parameters:
        audiences - audiences or null for none
      • getProviderId

        public String getProviderId()
        id from authentication provider. Example: provider_id: bookstore_auth
        Returns:
        value or null for none
      • setProviderId

        public AuthRequirement setProviderId(String providerId)
        id from authentication provider. Example: provider_id: bookstore_auth
        Parameters:
        providerId - providerId or null for none
      • clone

        public AuthRequirement clone()
        Overrides:
        clone in class com.google.api.client.json.GenericJson

Copyright © 2011–2024 Google. All rights reserved.





© 2015 - 2024 Weber Informatics LLC | Privacy Policy