Class: Google::Cloud::Connectors::V1::AuthConfig

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

Overview

AuthConfig defines details of a authentication type.

Defined Under Namespace

Classes: Oauth2ClientCredentials, Oauth2JwtBearer, SshPublicKey, UserPassword

Instance Attribute Summary collapse

Instance Attribute Details

#additional_variables ⇒ ::Array<::Google::Cloud::Connectors::V1::ConfigVariable>

Returns List containing additional auth configs.

Returns:



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'proto_docs/google/cloud/connectors/v1/authconfig.rb', line 43

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

  # Parameters to support Username and Password Authentication.
  # @!attribute [rw] username
  #   @return [::String]
  #     Username.
  # @!attribute [rw] password
  #   @return [::Google::Cloud::Connectors::V1::Secret]
  #     Secret version reference containing the password.
  class UserPassword
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0
  # Authorization Grant based authentication.
  # See https://tools.ietf.org/html/rfc7523 for more details.
  # @!attribute [rw] client_key
  #   @return [::Google::Cloud::Connectors::V1::Secret]
  #     Secret version reference containing a PKCS#8 PEM-encoded private
  #     key associated with the Client Certificate. This private key will be
  #     used to sign JWTs used for the jwt-bearer authorization grant.
  #     Specified in the form as: `projects/*/secrets/*/versions/*`.
  # @!attribute [rw] jwt_claims
  #   @return [::Google::Cloud::Connectors::V1::AuthConfig::Oauth2JwtBearer::JwtClaims]
  #     JwtClaims providers fields to generate the token.
  class Oauth2JwtBearer
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # JWT claims used for the jwt-bearer authorization grant.
    # @!attribute [rw] issuer
    #   @return [::String]
    #     Value for the "iss" claim.
    # @!attribute [rw] subject
    #   @return [::String]
    #     Value for the "sub" claim.
    # @!attribute [rw] audience
    #   @return [::String]
    #     Value for the "aud" claim.
    class JwtClaims
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Parameters to support Oauth 2.0 Client Credentials Grant Authentication.
  # See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details.
  # @!attribute [rw] client_id
  #   @return [::String]
  #     The client identifier.
  # @!attribute [rw] client_secret
  #   @return [::Google::Cloud::Connectors::V1::Secret]
  #     Secret version reference containing the client secret.
  class Oauth2ClientCredentials
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters to support Ssh public key Authentication.
  # @!attribute [rw] username
  #   @return [::String]
  #     The user account used to authenticate.
  # @!attribute [rw] ssh_client_cert
  #   @return [::Google::Cloud::Connectors::V1::Secret]
  #     SSH Client Cert. It should contain both public and private key.
  # @!attribute [rw] cert_type
  #   @return [::String]
  #     Format of SSH Client cert.
  # @!attribute [rw] ssh_client_cert_pass
  #   @return [::Google::Cloud::Connectors::V1::Secret]
  #     Password (passphrase) for ssh client certificate if it has one.
  class SshPublicKey
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#auth_type ⇒ ::Google::Cloud::Connectors::V1::AuthType

Returns The type of authentication configured.

Returns:



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'proto_docs/google/cloud/connectors/v1/authconfig.rb', line 43

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

  # Parameters to support Username and Password Authentication.
  # @!attribute [rw] username
  #   @return [::String]
  #     Username.
  # @!attribute [rw] password
  #   @return [::Google::Cloud::Connectors::V1::Secret]
  #     Secret version reference containing the password.
  class UserPassword
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0
  # Authorization Grant based authentication.
  # See https://tools.ietf.org/html/rfc7523 for more details.
  # @!attribute [rw] client_key
  #   @return [::Google::Cloud::Connectors::V1::Secret]
  #     Secret version reference containing a PKCS#8 PEM-encoded private
  #     key associated with the Client Certificate. This private key will be
  #     used to sign JWTs used for the jwt-bearer authorization grant.
  #     Specified in the form as: `projects/*/secrets/*/versions/*`.
  # @!attribute [rw] jwt_claims
  #   @return [::Google::Cloud::Connectors::V1::AuthConfig::Oauth2JwtBearer::JwtClaims]
  #     JwtClaims providers fields to generate the token.
  class Oauth2JwtBearer
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # JWT claims used for the jwt-bearer authorization grant.
    # @!attribute [rw] issuer
    #   @return [::String]
    #     Value for the "iss" claim.
    # @!attribute [rw] subject
    #   @return [::String]
    #     Value for the "sub" claim.
    # @!attribute [rw] audience
    #   @return [::String]
    #     Value for the "aud" claim.
    class JwtClaims
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Parameters to support Oauth 2.0 Client Credentials Grant Authentication.
  # See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details.
  # @!attribute [rw] client_id
  #   @return [::String]
  #     The client identifier.
  # @!attribute [rw] client_secret
  #   @return [::Google::Cloud::Connectors::V1::Secret]
  #     Secret version reference containing the client secret.
  class Oauth2ClientCredentials
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters to support Ssh public key Authentication.
  # @!attribute [rw] username
  #   @return [::String]
  #     The user account used to authenticate.
  # @!attribute [rw] ssh_client_cert
  #   @return [::Google::Cloud::Connectors::V1::Secret]
  #     SSH Client Cert. It should contain both public and private key.
  # @!attribute [rw] cert_type
  #   @return [::String]
  #     Format of SSH Client cert.
  # @!attribute [rw] ssh_client_cert_pass
  #   @return [::Google::Cloud::Connectors::V1::Secret]
  #     Password (passphrase) for ssh client certificate if it has one.
  class SshPublicKey
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#oauth2_client_credentials ⇒ ::Google::Cloud::Connectors::V1::AuthConfig::Oauth2ClientCredentials

Returns Oauth2ClientCredentials.

Returns:



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'proto_docs/google/cloud/connectors/v1/authconfig.rb', line 43

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

  # Parameters to support Username and Password Authentication.
  # @!attribute [rw] username
  #   @return [::String]
  #     Username.
  # @!attribute [rw] password
  #   @return [::Google::Cloud::Connectors::V1::Secret]
  #     Secret version reference containing the password.
  class UserPassword
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0
  # Authorization Grant based authentication.
  # See https://tools.ietf.org/html/rfc7523 for more details.
  # @!attribute [rw] client_key
  #   @return [::Google::Cloud::Connectors::V1::Secret]
  #     Secret version reference containing a PKCS#8 PEM-encoded private
  #     key associated with the Client Certificate. This private key will be
  #     used to sign JWTs used for the jwt-bearer authorization grant.
  #     Specified in the form as: `projects/*/secrets/*/versions/*`.
  # @!attribute [rw] jwt_claims
  #   @return [::Google::Cloud::Connectors::V1::AuthConfig::Oauth2JwtBearer::JwtClaims]
  #     JwtClaims providers fields to generate the token.
  class Oauth2JwtBearer
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # JWT claims used for the jwt-bearer authorization grant.
    # @!attribute [rw] issuer
    #   @return [::String]
    #     Value for the "iss" claim.
    # @!attribute [rw] subject
    #   @return [::String]
    #     Value for the "sub" claim.
    # @!attribute [rw] audience
    #   @return [::String]
    #     Value for the "aud" claim.
    class JwtClaims
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Parameters to support Oauth 2.0 Client Credentials Grant Authentication.
  # See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details.
  # @!attribute [rw] client_id
  #   @return [::String]
  #     The client identifier.
  # @!attribute [rw] client_secret
  #   @return [::Google::Cloud::Connectors::V1::Secret]
  #     Secret version reference containing the client secret.
  class Oauth2ClientCredentials
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters to support Ssh public key Authentication.
  # @!attribute [rw] username
  #   @return [::String]
  #     The user account used to authenticate.
  # @!attribute [rw] ssh_client_cert
  #   @return [::Google::Cloud::Connectors::V1::Secret]
  #     SSH Client Cert. It should contain both public and private key.
  # @!attribute [rw] cert_type
  #   @return [::String]
  #     Format of SSH Client cert.
  # @!attribute [rw] ssh_client_cert_pass
  #   @return [::Google::Cloud::Connectors::V1::Secret]
  #     Password (passphrase) for ssh client certificate if it has one.
  class SshPublicKey
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#oauth2_jwt_bearer ⇒ ::Google::Cloud::Connectors::V1::AuthConfig::Oauth2JwtBearer

Returns Oauth2JwtBearer.

Returns:



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'proto_docs/google/cloud/connectors/v1/authconfig.rb', line 43

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

  # Parameters to support Username and Password Authentication.
  # @!attribute [rw] username
  #   @return [::String]
  #     Username.
  # @!attribute [rw] password
  #   @return [::Google::Cloud::Connectors::V1::Secret]
  #     Secret version reference containing the password.
  class UserPassword
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0
  # Authorization Grant based authentication.
  # See https://tools.ietf.org/html/rfc7523 for more details.
  # @!attribute [rw] client_key
  #   @return [::Google::Cloud::Connectors::V1::Secret]
  #     Secret version reference containing a PKCS#8 PEM-encoded private
  #     key associated with the Client Certificate. This private key will be
  #     used to sign JWTs used for the jwt-bearer authorization grant.
  #     Specified in the form as: `projects/*/secrets/*/versions/*`.
  # @!attribute [rw] jwt_claims
  #   @return [::Google::Cloud::Connectors::V1::AuthConfig::Oauth2JwtBearer::JwtClaims]
  #     JwtClaims providers fields to generate the token.
  class Oauth2JwtBearer
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # JWT claims used for the jwt-bearer authorization grant.
    # @!attribute [rw] issuer
    #   @return [::String]
    #     Value for the "iss" claim.
    # @!attribute [rw] subject
    #   @return [::String]
    #     Value for the "sub" claim.
    # @!attribute [rw] audience
    #   @return [::String]
    #     Value for the "aud" claim.
    class JwtClaims
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Parameters to support Oauth 2.0 Client Credentials Grant Authentication.
  # See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details.
  # @!attribute [rw] client_id
  #   @return [::String]
  #     The client identifier.
  # @!attribute [rw] client_secret
  #   @return [::Google::Cloud::Connectors::V1::Secret]
  #     Secret version reference containing the client secret.
  class Oauth2ClientCredentials
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters to support Ssh public key Authentication.
  # @!attribute [rw] username
  #   @return [::String]
  #     The user account used to authenticate.
  # @!attribute [rw] ssh_client_cert
  #   @return [::Google::Cloud::Connectors::V1::Secret]
  #     SSH Client Cert. It should contain both public and private key.
  # @!attribute [rw] cert_type
  #   @return [::String]
  #     Format of SSH Client cert.
  # @!attribute [rw] ssh_client_cert_pass
  #   @return [::Google::Cloud::Connectors::V1::Secret]
  #     Password (passphrase) for ssh client certificate if it has one.
  class SshPublicKey
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#ssh_public_key ⇒ ::Google::Cloud::Connectors::V1::AuthConfig::SshPublicKey

Returns SSH Public Key.

Returns:



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'proto_docs/google/cloud/connectors/v1/authconfig.rb', line 43

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

  # Parameters to support Username and Password Authentication.
  # @!attribute [rw] username
  #   @return [::String]
  #     Username.
  # @!attribute [rw] password
  #   @return [::Google::Cloud::Connectors::V1::Secret]
  #     Secret version reference containing the password.
  class UserPassword
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0
  # Authorization Grant based authentication.
  # See https://tools.ietf.org/html/rfc7523 for more details.
  # @!attribute [rw] client_key
  #   @return [::Google::Cloud::Connectors::V1::Secret]
  #     Secret version reference containing a PKCS#8 PEM-encoded private
  #     key associated with the Client Certificate. This private key will be
  #     used to sign JWTs used for the jwt-bearer authorization grant.
  #     Specified in the form as: `projects/*/secrets/*/versions/*`.
  # @!attribute [rw] jwt_claims
  #   @return [::Google::Cloud::Connectors::V1::AuthConfig::Oauth2JwtBearer::JwtClaims]
  #     JwtClaims providers fields to generate the token.
  class Oauth2JwtBearer
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # JWT claims used for the jwt-bearer authorization grant.
    # @!attribute [rw] issuer
    #   @return [::String]
    #     Value for the "iss" claim.
    # @!attribute [rw] subject
    #   @return [::String]
    #     Value for the "sub" claim.
    # @!attribute [rw] audience
    #   @return [::String]
    #     Value for the "aud" claim.
    class JwtClaims
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Parameters to support Oauth 2.0 Client Credentials Grant Authentication.
  # See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details.
  # @!attribute [rw] client_id
  #   @return [::String]
  #     The client identifier.
  # @!attribute [rw] client_secret
  #   @return [::Google::Cloud::Connectors::V1::Secret]
  #     Secret version reference containing the client secret.
  class Oauth2ClientCredentials
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters to support Ssh public key Authentication.
  # @!attribute [rw] username
  #   @return [::String]
  #     The user account used to authenticate.
  # @!attribute [rw] ssh_client_cert
  #   @return [::Google::Cloud::Connectors::V1::Secret]
  #     SSH Client Cert. It should contain both public and private key.
  # @!attribute [rw] cert_type
  #   @return [::String]
  #     Format of SSH Client cert.
  # @!attribute [rw] ssh_client_cert_pass
  #   @return [::Google::Cloud::Connectors::V1::Secret]
  #     Password (passphrase) for ssh client certificate if it has one.
  class SshPublicKey
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#user_password ⇒ ::Google::Cloud::Connectors::V1::AuthConfig::UserPassword

Returns UserPassword.

Returns:



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'proto_docs/google/cloud/connectors/v1/authconfig.rb', line 43

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

  # Parameters to support Username and Password Authentication.
  # @!attribute [rw] username
  #   @return [::String]
  #     Username.
  # @!attribute [rw] password
  #   @return [::Google::Cloud::Connectors::V1::Secret]
  #     Secret version reference containing the password.
  class UserPassword
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0
  # Authorization Grant based authentication.
  # See https://tools.ietf.org/html/rfc7523 for more details.
  # @!attribute [rw] client_key
  #   @return [::Google::Cloud::Connectors::V1::Secret]
  #     Secret version reference containing a PKCS#8 PEM-encoded private
  #     key associated with the Client Certificate. This private key will be
  #     used to sign JWTs used for the jwt-bearer authorization grant.
  #     Specified in the form as: `projects/*/secrets/*/versions/*`.
  # @!attribute [rw] jwt_claims
  #   @return [::Google::Cloud::Connectors::V1::AuthConfig::Oauth2JwtBearer::JwtClaims]
  #     JwtClaims providers fields to generate the token.
  class Oauth2JwtBearer
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # JWT claims used for the jwt-bearer authorization grant.
    # @!attribute [rw] issuer
    #   @return [::String]
    #     Value for the "iss" claim.
    # @!attribute [rw] subject
    #   @return [::String]
    #     Value for the "sub" claim.
    # @!attribute [rw] audience
    #   @return [::String]
    #     Value for the "aud" claim.
    class JwtClaims
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Parameters to support Oauth 2.0 Client Credentials Grant Authentication.
  # See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details.
  # @!attribute [rw] client_id
  #   @return [::String]
  #     The client identifier.
  # @!attribute [rw] client_secret
  #   @return [::Google::Cloud::Connectors::V1::Secret]
  #     Secret version reference containing the client secret.
  class Oauth2ClientCredentials
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters to support Ssh public key Authentication.
  # @!attribute [rw] username
  #   @return [::String]
  #     The user account used to authenticate.
  # @!attribute [rw] ssh_client_cert
  #   @return [::Google::Cloud::Connectors::V1::Secret]
  #     SSH Client Cert. It should contain both public and private key.
  # @!attribute [rw] cert_type
  #   @return [::String]
  #     Format of SSH Client cert.
  # @!attribute [rw] ssh_client_cert_pass
  #   @return [::Google::Cloud::Connectors::V1::Secret]
  #     Password (passphrase) for ssh client certificate if it has one.
  class SshPublicKey
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end