Class: Google::Cloud::Ces::V1::OAuthConfig

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/ces/v1/auth.rb

Overview

Configurations for authentication with OAuth.

Defined Under Namespace

Modules: OauthGrantType

Instance Attribute Summary collapse

Instance Attribute Details

#client_id ⇒ ::String

Returns Required. The client ID from the OAuth provider.

Returns:

  • (::String) —

    Required. The client ID from the OAuth provider.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'proto_docs/google/cloud/ces/v1/auth.rb', line 81

class OAuthConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # OAuth grant types. Only [client credential
  # grant](https://oauth.net/2/grant-types/client-credentials) is supported.
  module OauthGrantType
    # Unspecified. Defaults to CLIENT_CREDENTIAL.
    OAUTH_GRANT_TYPE_UNSPECIFIED = 0

    # Represents the [client credential
    # flow](https://oauth.net/2/grant-types/client-credentials).
    CLIENT_CREDENTIAL = 1
  end
end

#client_secret_version ⇒ ::String

Returns Required. The name of the SecretManager secret version resource storing the client secret. Format: projects/{project}/secrets/{secret}/versions/{version}

Note: You should grant roles/secretmanager.secretAccessor role to the CES service agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

Returns:

  • (::String) —

    Required. The name of the SecretManager secret version resource storing the client secret. Format: projects/{project}/secrets/{secret}/versions/{version}

    Note: You should grant roles/secretmanager.secretAccessor role to the CES service agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'proto_docs/google/cloud/ces/v1/auth.rb', line 81

class OAuthConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # OAuth grant types. Only [client credential
  # grant](https://oauth.net/2/grant-types/client-credentials) is supported.
  module OauthGrantType
    # Unspecified. Defaults to CLIENT_CREDENTIAL.
    OAUTH_GRANT_TYPE_UNSPECIFIED = 0

    # Represents the [client credential
    # flow](https://oauth.net/2/grant-types/client-credentials).
    CLIENT_CREDENTIAL = 1
  end
end

#oauth_grant_type ⇒ ::Google::Cloud::Ces::V1::OAuthConfig::OauthGrantType

Returns Required. OAuth grant types.

Returns:



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'proto_docs/google/cloud/ces/v1/auth.rb', line 81

class OAuthConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # OAuth grant types. Only [client credential
  # grant](https://oauth.net/2/grant-types/client-credentials) is supported.
  module OauthGrantType
    # Unspecified. Defaults to CLIENT_CREDENTIAL.
    OAUTH_GRANT_TYPE_UNSPECIFIED = 0

    # Represents the [client credential
    # flow](https://oauth.net/2/grant-types/client-credentials).
    CLIENT_CREDENTIAL = 1
  end
end

#scopes ⇒ ::Array<::String>

Returns Optional. The OAuth scopes to grant.

Returns:

  • (::Array<::String>) —

    Optional. The OAuth scopes to grant.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'proto_docs/google/cloud/ces/v1/auth.rb', line 81

class OAuthConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # OAuth grant types. Only [client credential
  # grant](https://oauth.net/2/grant-types/client-credentials) is supported.
  module OauthGrantType
    # Unspecified. Defaults to CLIENT_CREDENTIAL.
    OAUTH_GRANT_TYPE_UNSPECIFIED = 0

    # Represents the [client credential
    # flow](https://oauth.net/2/grant-types/client-credentials).
    CLIENT_CREDENTIAL = 1
  end
end

#token_endpoint ⇒ ::String

Returns Required. The token endpoint in the OAuth provider to exchange for an access token.

Returns:

  • (::String) —

    Required. The token endpoint in the OAuth provider to exchange for an access token.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'proto_docs/google/cloud/ces/v1/auth.rb', line 81

class OAuthConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # OAuth grant types. Only [client credential
  # grant](https://oauth.net/2/grant-types/client-credentials) is supported.
  module OauthGrantType
    # Unspecified. Defaults to CLIENT_CREDENTIAL.
    OAUTH_GRANT_TYPE_UNSPECIFIED = 0

    # Represents the [client credential
    # flow](https://oauth.net/2/grant-types/client-credentials).
    CLIENT_CREDENTIAL = 1
  end
end