Close httplib2 connections.
create(parent, body=None, endUserAuthenticationId=None, x__xgafv=None)
Creates a new EndUserAuthentication in a given project,location and connection.
Deletes a single EndUserAuthentication.
get(name, view=None, x__xgafv=None)
Gets details of a single EndUserAuthentication.
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
List EndUserAuthentications in a given project,location and connection.
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates the parameters of a single EndUserAuthentication.
close()
Close httplib2 connections.
create(parent, body=None, endUserAuthenticationId=None, x__xgafv=None)
Creates a new EndUserAuthentication in a given project,location and connection. Args: parent: string, Required. Parent resource of the EndUserAuthentication, of the form: `projects/*/locations/*/connections/*` (required) body: object, The request body. The object takes the form of: { # AuthConfig defines details of a authentication type. "configVariables": [ # Optional. Config variables for the EndUserAuthentication. { # EndUserAuthenticationConfigVariable represents a configuration variable present in a EndUserAuthentication. "boolValue": True or False, # Value is a bool. "intValue": "A String", # Value is an integer "key": "A String", # Required. Key of the config variable. "secretValue": { # EUASecret provides a reference to entries in Secret Manager. # Value is a secret "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, "stringValue": "A String", # Value is a string. }, ], "createTime": "A String", # Output only. Created time. "destinationConfigs": [ # Optional. Destination configs for the EndUserAuthentication. { # Define the Connectors target endpoint. "destinations": [ # The destinations for the key. { "host": "A String", # For publicly routable host. "port": 42, # The port is the target port number that is accepted by the destination. "serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/* }, ], "key": "A String", # The key is the destination identifier that is supported by the Connector. }, ], "endUserAuthenticationConfig": { # EndUserAuthenticationConfig defines details of a authentication configuration for EUC # Optional. The EndUserAuthenticationConfig for the EndUserAuthentication. "additionalVariables": [ # Optional. List containing additional auth configs. { # EndUserAuthenticationConfigVariable represents a configuration variable present in a EndUserAuthentication. "boolValue": True or False, # Value is a bool. "intValue": "A String", # Value is an integer "key": "A String", # Required. Key of the config variable. "secretValue": { # EUASecret provides a reference to entries in Secret Manager. # Value is a secret "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, "stringValue": "A String", # Value is a string. }, ], "authKey": "A String", # Identifier key for auth config "authType": "A String", # The type of authentication configured. "oauth2AuthCodeFlow": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication. See https://www.rfc-editor.org/rfc/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlow. "authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens. "authUri": "A String", # Optional. Auth URL for Authorization Code Flow "clientId": "A String", # Optional. Client ID for user-provided OAuth app. "clientSecret": { # EUASecret provides a reference to entries in Secret Manager. # Optional. Client secret for user-provided OAuth app. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, "enablePkce": True or False, # Optional. Whether to enable PKCE when the user performs the auth code flow. "oauthTokenData": { # pass only at create and not update using updateMask Auth Code Data # Optional. Auth Code Data "accessToken": { # EUASecret provides a reference to entries in Secret Manager. # Optional. Access token for the connection. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, "createTime": "A String", # Optional. Timestamp when the access token was created. "expiry": "A String", # Optional. Time in seconds when the access token expires. "refreshToken": { # EUASecret provides a reference to entries in Secret Manager. # Optional. Refresh token for the connection. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, }, "pkceVerifier": "A String", # Optional. PKCE verifier to be used during the auth code exchange. "redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange. "scopes": [ # Optional. Scopes the connection will request when the user performs the auth code flow. "A String", ], }, "oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged. "authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens. "oauthTokenData": { # pass only at create and not update using updateMask Auth Code Data # Auth Code Data "accessToken": { # EUASecret provides a reference to entries in Secret Manager. # Optional. Access token for the connection. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, "createTime": "A String", # Optional. Timestamp when the access token was created. "expiry": "A String", # Optional. Time in seconds when the access token expires. "refreshToken": { # EUASecret provides a reference to entries in Secret Manager. # Optional. Refresh token for the connection. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, }, "redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange. "scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow. "A String", ], }, "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials. "clientId": "A String", # The client identifier. "clientSecret": { # EUASecret provides a reference to entries in Secret Manager. # Required. string value or secret version containing the client secret. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, }, "oauth2JwtBearer": { # 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. # Oauth2JwtBearer. "clientKey": { # EUASecret provides a reference to entries in Secret Manager. # Required. secret version/value 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/*/strings/*/versions/*`. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, "jwtClaims": { # JWT claims used for the jwt-bearer authorization grant. # JwtClaims providers fields to generate the token. "audience": "A String", # Value for the "aud" claim. "issuer": "A String", # Value for the "iss" claim. "subject": "A String", # Value for the "sub" claim. }, }, "sshPublicKey": { # Parameters to support Ssh public key Authentication. # SSH Public Key. "certType": "A String", # Format of SSH Client cert. "sshClientCert": { # EUASecret provides a reference to entries in Secret Manager. # Required. SSH Client Cert. It should contain both public and private key. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, "sshClientCertPass": { # EUASecret provides a reference to entries in Secret Manager. # Required. Password (passphrase) for ssh client certificate if it has one. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, "username": "A String", # The user account used to authenticate. }, "userPassword": { # Parameters to support Username and Password Authentication. # UserPassword. "password": { # EUASecret provides a reference to entries in Secret Manager. # Required. string value or secret version reference containing the password. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, "username": "A String", # Username. }, }, "labels": [ # Optional. Labels for the EndUserAuthentication. "A String", ], "name": "A String", # Required. Identifier. Resource name of the EndUserAuthentication. Format: projects/{project}/locations/{location}/connections/{connection}/endUserAuthentications/{end_user_authentication} "notifyEndpointDestination": { # Message for NotifyEndpointDestination Destination to hit when the refresh token is expired. # Optional. The destination to hit when we receive an event "endpoint": { # Endpoint message includes details of the Destination endpoint. # Optional. OPTION 1: Hit an endpoint when the refresh token is expired. "endpointUri": "A String", # Required. The URI of the Endpoint. "headers": [ # Optional. List of Header to be added to the Endpoint. { # Header details for a given header to be added to Endpoint. "key": "A String", # Required. Key of Header. "value": "A String", # Required. Value of Header. }, ], }, "serviceAccount": "A String", # Required. Service account needed for runtime plane to notify the backend. "type": "A String", # Required. type of the destination }, "roles": [ # Optional. Roles for the EndUserAuthentication. "A String", ], "status": { # EndUserAuthentication Status denotes the status of the EndUserAuthentication resource. # Optional. Status of the EndUserAuthentication. "description": "A String", # Output only. Description of the state. "state": "A String", # Output only. State of Event Subscription resource. }, "updateTime": "A String", # Output only. Updated time. "userId": "A String", # Optional. The user id of the user. } endUserAuthenticationId: string, Required. Identifier to assign to the EndUserAuthentication. Must be unique within scope of the parent resource. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # This resource represents a long-running operation that is the result of a network API call. "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { "a_key": "", # Properties of the object. Contains field @type with type URL. }, ], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. "a_key": "", # Properties of the object. Contains field @type with type URL. }, "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. "a_key": "", # Properties of the object. Contains field @type with type URL. }, }
delete(name, x__xgafv=None)
Deletes a single EndUserAuthentication. Args: name: string, Required. Resource name of the form: `projects/*/locations/*/connections/*/endUserAuthentication/*` (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # This resource represents a long-running operation that is the result of a network API call. "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { "a_key": "", # Properties of the object. Contains field @type with type URL. }, ], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. "a_key": "", # Properties of the object. Contains field @type with type URL. }, "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. "a_key": "", # Properties of the object. Contains field @type with type URL. }, }
get(name, view=None, x__xgafv=None)
Gets details of a single EndUserAuthentication. Args: name: string, Required. Resource name of the form: `projects/*/locations/*/connections/*/EndUserAuthentications/*` (required) view: string, Optional. View of the EndUserAuthentication to return. Allowed values END_USER_AUTHENTICATION_VIEW_UNSPECIFIED - END_USER_AUTHENTICATION_UNSPECIFIED. BASIC_VIEW - Do not include secret fields. FULL_VIEW - Include secret fields. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # AuthConfig defines details of a authentication type. "configVariables": [ # Optional. Config variables for the EndUserAuthentication. { # EndUserAuthenticationConfigVariable represents a configuration variable present in a EndUserAuthentication. "boolValue": True or False, # Value is a bool. "intValue": "A String", # Value is an integer "key": "A String", # Required. Key of the config variable. "secretValue": { # EUASecret provides a reference to entries in Secret Manager. # Value is a secret "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, "stringValue": "A String", # Value is a string. }, ], "createTime": "A String", # Output only. Created time. "destinationConfigs": [ # Optional. Destination configs for the EndUserAuthentication. { # Define the Connectors target endpoint. "destinations": [ # The destinations for the key. { "host": "A String", # For publicly routable host. "port": 42, # The port is the target port number that is accepted by the destination. "serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/* }, ], "key": "A String", # The key is the destination identifier that is supported by the Connector. }, ], "endUserAuthenticationConfig": { # EndUserAuthenticationConfig defines details of a authentication configuration for EUC # Optional. The EndUserAuthenticationConfig for the EndUserAuthentication. "additionalVariables": [ # Optional. List containing additional auth configs. { # EndUserAuthenticationConfigVariable represents a configuration variable present in a EndUserAuthentication. "boolValue": True or False, # Value is a bool. "intValue": "A String", # Value is an integer "key": "A String", # Required. Key of the config variable. "secretValue": { # EUASecret provides a reference to entries in Secret Manager. # Value is a secret "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, "stringValue": "A String", # Value is a string. }, ], "authKey": "A String", # Identifier key for auth config "authType": "A String", # The type of authentication configured. "oauth2AuthCodeFlow": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication. See https://www.rfc-editor.org/rfc/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlow. "authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens. "authUri": "A String", # Optional. Auth URL for Authorization Code Flow "clientId": "A String", # Optional. Client ID for user-provided OAuth app. "clientSecret": { # EUASecret provides a reference to entries in Secret Manager. # Optional. Client secret for user-provided OAuth app. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, "enablePkce": True or False, # Optional. Whether to enable PKCE when the user performs the auth code flow. "oauthTokenData": { # pass only at create and not update using updateMask Auth Code Data # Optional. Auth Code Data "accessToken": { # EUASecret provides a reference to entries in Secret Manager. # Optional. Access token for the connection. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, "createTime": "A String", # Optional. Timestamp when the access token was created. "expiry": "A String", # Optional. Time in seconds when the access token expires. "refreshToken": { # EUASecret provides a reference to entries in Secret Manager. # Optional. Refresh token for the connection. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, }, "pkceVerifier": "A String", # Optional. PKCE verifier to be used during the auth code exchange. "redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange. "scopes": [ # Optional. Scopes the connection will request when the user performs the auth code flow. "A String", ], }, "oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged. "authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens. "oauthTokenData": { # pass only at create and not update using updateMask Auth Code Data # Auth Code Data "accessToken": { # EUASecret provides a reference to entries in Secret Manager. # Optional. Access token for the connection. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, "createTime": "A String", # Optional. Timestamp when the access token was created. "expiry": "A String", # Optional. Time in seconds when the access token expires. "refreshToken": { # EUASecret provides a reference to entries in Secret Manager. # Optional. Refresh token for the connection. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, }, "redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange. "scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow. "A String", ], }, "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials. "clientId": "A String", # The client identifier. "clientSecret": { # EUASecret provides a reference to entries in Secret Manager. # Required. string value or secret version containing the client secret. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, }, "oauth2JwtBearer": { # 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. # Oauth2JwtBearer. "clientKey": { # EUASecret provides a reference to entries in Secret Manager. # Required. secret version/value 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/*/strings/*/versions/*`. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, "jwtClaims": { # JWT claims used for the jwt-bearer authorization grant. # JwtClaims providers fields to generate the token. "audience": "A String", # Value for the "aud" claim. "issuer": "A String", # Value for the "iss" claim. "subject": "A String", # Value for the "sub" claim. }, }, "sshPublicKey": { # Parameters to support Ssh public key Authentication. # SSH Public Key. "certType": "A String", # Format of SSH Client cert. "sshClientCert": { # EUASecret provides a reference to entries in Secret Manager. # Required. SSH Client Cert. It should contain both public and private key. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, "sshClientCertPass": { # EUASecret provides a reference to entries in Secret Manager. # Required. Password (passphrase) for ssh client certificate if it has one. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, "username": "A String", # The user account used to authenticate. }, "userPassword": { # Parameters to support Username and Password Authentication. # UserPassword. "password": { # EUASecret provides a reference to entries in Secret Manager. # Required. string value or secret version reference containing the password. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, "username": "A String", # Username. }, }, "labels": [ # Optional. Labels for the EndUserAuthentication. "A String", ], "name": "A String", # Required. Identifier. Resource name of the EndUserAuthentication. Format: projects/{project}/locations/{location}/connections/{connection}/endUserAuthentications/{end_user_authentication} "notifyEndpointDestination": { # Message for NotifyEndpointDestination Destination to hit when the refresh token is expired. # Optional. The destination to hit when we receive an event "endpoint": { # Endpoint message includes details of the Destination endpoint. # Optional. OPTION 1: Hit an endpoint when the refresh token is expired. "endpointUri": "A String", # Required. The URI of the Endpoint. "headers": [ # Optional. List of Header to be added to the Endpoint. { # Header details for a given header to be added to Endpoint. "key": "A String", # Required. Key of Header. "value": "A String", # Required. Value of Header. }, ], }, "serviceAccount": "A String", # Required. Service account needed for runtime plane to notify the backend. "type": "A String", # Required. type of the destination }, "roles": [ # Optional. Roles for the EndUserAuthentication. "A String", ], "status": { # EndUserAuthentication Status denotes the status of the EndUserAuthentication resource. # Optional. Status of the EndUserAuthentication. "description": "A String", # Output only. Description of the state. "state": "A String", # Output only. State of Event Subscription resource. }, "updateTime": "A String", # Output only. Updated time. "userId": "A String", # Optional. The user id of the user. }
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
List EndUserAuthentications in a given project,location and connection. Args: parent: string, Required. Parent resource of the EndUserAuthentication, of the form: `projects/*/locations/*/connections/*` (required) filter: string, Filter. orderBy: string, Order by parameters. pageSize: integer, Page size. pageToken: string, Page token. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # Response message for ConnectorsService.ListEndUserAuthentications "endUserAuthentications": [ # Subscriptions. { # AuthConfig defines details of a authentication type. "configVariables": [ # Optional. Config variables for the EndUserAuthentication. { # EndUserAuthenticationConfigVariable represents a configuration variable present in a EndUserAuthentication. "boolValue": True or False, # Value is a bool. "intValue": "A String", # Value is an integer "key": "A String", # Required. Key of the config variable. "secretValue": { # EUASecret provides a reference to entries in Secret Manager. # Value is a secret "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, "stringValue": "A String", # Value is a string. }, ], "createTime": "A String", # Output only. Created time. "destinationConfigs": [ # Optional. Destination configs for the EndUserAuthentication. { # Define the Connectors target endpoint. "destinations": [ # The destinations for the key. { "host": "A String", # For publicly routable host. "port": 42, # The port is the target port number that is accepted by the destination. "serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/* }, ], "key": "A String", # The key is the destination identifier that is supported by the Connector. }, ], "endUserAuthenticationConfig": { # EndUserAuthenticationConfig defines details of a authentication configuration for EUC # Optional. The EndUserAuthenticationConfig for the EndUserAuthentication. "additionalVariables": [ # Optional. List containing additional auth configs. { # EndUserAuthenticationConfigVariable represents a configuration variable present in a EndUserAuthentication. "boolValue": True or False, # Value is a bool. "intValue": "A String", # Value is an integer "key": "A String", # Required. Key of the config variable. "secretValue": { # EUASecret provides a reference to entries in Secret Manager. # Value is a secret "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, "stringValue": "A String", # Value is a string. }, ], "authKey": "A String", # Identifier key for auth config "authType": "A String", # The type of authentication configured. "oauth2AuthCodeFlow": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication. See https://www.rfc-editor.org/rfc/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlow. "authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens. "authUri": "A String", # Optional. Auth URL for Authorization Code Flow "clientId": "A String", # Optional. Client ID for user-provided OAuth app. "clientSecret": { # EUASecret provides a reference to entries in Secret Manager. # Optional. Client secret for user-provided OAuth app. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, "enablePkce": True or False, # Optional. Whether to enable PKCE when the user performs the auth code flow. "oauthTokenData": { # pass only at create and not update using updateMask Auth Code Data # Optional. Auth Code Data "accessToken": { # EUASecret provides a reference to entries in Secret Manager. # Optional. Access token for the connection. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, "createTime": "A String", # Optional. Timestamp when the access token was created. "expiry": "A String", # Optional. Time in seconds when the access token expires. "refreshToken": { # EUASecret provides a reference to entries in Secret Manager. # Optional. Refresh token for the connection. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, }, "pkceVerifier": "A String", # Optional. PKCE verifier to be used during the auth code exchange. "redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange. "scopes": [ # Optional. Scopes the connection will request when the user performs the auth code flow. "A String", ], }, "oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged. "authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens. "oauthTokenData": { # pass only at create and not update using updateMask Auth Code Data # Auth Code Data "accessToken": { # EUASecret provides a reference to entries in Secret Manager. # Optional. Access token for the connection. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, "createTime": "A String", # Optional. Timestamp when the access token was created. "expiry": "A String", # Optional. Time in seconds when the access token expires. "refreshToken": { # EUASecret provides a reference to entries in Secret Manager. # Optional. Refresh token for the connection. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, }, "redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange. "scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow. "A String", ], }, "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials. "clientId": "A String", # The client identifier. "clientSecret": { # EUASecret provides a reference to entries in Secret Manager. # Required. string value or secret version containing the client secret. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, }, "oauth2JwtBearer": { # 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. # Oauth2JwtBearer. "clientKey": { # EUASecret provides a reference to entries in Secret Manager. # Required. secret version/value 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/*/strings/*/versions/*`. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, "jwtClaims": { # JWT claims used for the jwt-bearer authorization grant. # JwtClaims providers fields to generate the token. "audience": "A String", # Value for the "aud" claim. "issuer": "A String", # Value for the "iss" claim. "subject": "A String", # Value for the "sub" claim. }, }, "sshPublicKey": { # Parameters to support Ssh public key Authentication. # SSH Public Key. "certType": "A String", # Format of SSH Client cert. "sshClientCert": { # EUASecret provides a reference to entries in Secret Manager. # Required. SSH Client Cert. It should contain both public and private key. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, "sshClientCertPass": { # EUASecret provides a reference to entries in Secret Manager. # Required. Password (passphrase) for ssh client certificate if it has one. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, "username": "A String", # The user account used to authenticate. }, "userPassword": { # Parameters to support Username and Password Authentication. # UserPassword. "password": { # EUASecret provides a reference to entries in Secret Manager. # Required. string value or secret version reference containing the password. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, "username": "A String", # Username. }, }, "labels": [ # Optional. Labels for the EndUserAuthentication. "A String", ], "name": "A String", # Required. Identifier. Resource name of the EndUserAuthentication. Format: projects/{project}/locations/{location}/connections/{connection}/endUserAuthentications/{end_user_authentication} "notifyEndpointDestination": { # Message for NotifyEndpointDestination Destination to hit when the refresh token is expired. # Optional. The destination to hit when we receive an event "endpoint": { # Endpoint message includes details of the Destination endpoint. # Optional. OPTION 1: Hit an endpoint when the refresh token is expired. "endpointUri": "A String", # Required. The URI of the Endpoint. "headers": [ # Optional. List of Header to be added to the Endpoint. { # Header details for a given header to be added to Endpoint. "key": "A String", # Required. Key of Header. "value": "A String", # Required. Value of Header. }, ], }, "serviceAccount": "A String", # Required. Service account needed for runtime plane to notify the backend. "type": "A String", # Required. type of the destination }, "roles": [ # Optional. Roles for the EndUserAuthentication. "A String", ], "status": { # EndUserAuthentication Status denotes the status of the EndUserAuthentication resource. # Optional. Status of the EndUserAuthentication. "description": "A String", # Output only. Description of the state. "state": "A String", # Output only. State of Event Subscription resource. }, "updateTime": "A String", # Output only. Updated time. "userId": "A String", # Optional. The user id of the user. }, ], "nextPageToken": "A String", # Next page token. "unreachable": [ # Locations that could not be reached. "A String", ], }
list_next()
Retrieves the next page of results. Args: previous_request: The request for the previous page. (required) previous_response: The response from the request for the previous page. (required) Returns: A request object that you can call 'execute()' on to request the next page. Returns None if there are no more items in the collection.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates the parameters of a single EndUserAuthentication. Args: name: string, Required. Identifier. Resource name of the EndUserAuthentication. Format: projects/{project}/locations/{location}/connections/{connection}/endUserAuthentications/{end_user_authentication} (required) body: object, The request body. The object takes the form of: { # AuthConfig defines details of a authentication type. "configVariables": [ # Optional. Config variables for the EndUserAuthentication. { # EndUserAuthenticationConfigVariable represents a configuration variable present in a EndUserAuthentication. "boolValue": True or False, # Value is a bool. "intValue": "A String", # Value is an integer "key": "A String", # Required. Key of the config variable. "secretValue": { # EUASecret provides a reference to entries in Secret Manager. # Value is a secret "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, "stringValue": "A String", # Value is a string. }, ], "createTime": "A String", # Output only. Created time. "destinationConfigs": [ # Optional. Destination configs for the EndUserAuthentication. { # Define the Connectors target endpoint. "destinations": [ # The destinations for the key. { "host": "A String", # For publicly routable host. "port": 42, # The port is the target port number that is accepted by the destination. "serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/* }, ], "key": "A String", # The key is the destination identifier that is supported by the Connector. }, ], "endUserAuthenticationConfig": { # EndUserAuthenticationConfig defines details of a authentication configuration for EUC # Optional. The EndUserAuthenticationConfig for the EndUserAuthentication. "additionalVariables": [ # Optional. List containing additional auth configs. { # EndUserAuthenticationConfigVariable represents a configuration variable present in a EndUserAuthentication. "boolValue": True or False, # Value is a bool. "intValue": "A String", # Value is an integer "key": "A String", # Required. Key of the config variable. "secretValue": { # EUASecret provides a reference to entries in Secret Manager. # Value is a secret "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, "stringValue": "A String", # Value is a string. }, ], "authKey": "A String", # Identifier key for auth config "authType": "A String", # The type of authentication configured. "oauth2AuthCodeFlow": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication. See https://www.rfc-editor.org/rfc/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlow. "authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens. "authUri": "A String", # Optional. Auth URL for Authorization Code Flow "clientId": "A String", # Optional. Client ID for user-provided OAuth app. "clientSecret": { # EUASecret provides a reference to entries in Secret Manager. # Optional. Client secret for user-provided OAuth app. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, "enablePkce": True or False, # Optional. Whether to enable PKCE when the user performs the auth code flow. "oauthTokenData": { # pass only at create and not update using updateMask Auth Code Data # Optional. Auth Code Data "accessToken": { # EUASecret provides a reference to entries in Secret Manager. # Optional. Access token for the connection. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, "createTime": "A String", # Optional. Timestamp when the access token was created. "expiry": "A String", # Optional. Time in seconds when the access token expires. "refreshToken": { # EUASecret provides a reference to entries in Secret Manager. # Optional. Refresh token for the connection. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, }, "pkceVerifier": "A String", # Optional. PKCE verifier to be used during the auth code exchange. "redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange. "scopes": [ # Optional. Scopes the connection will request when the user performs the auth code flow. "A String", ], }, "oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged. "authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens. "oauthTokenData": { # pass only at create and not update using updateMask Auth Code Data # Auth Code Data "accessToken": { # EUASecret provides a reference to entries in Secret Manager. # Optional. Access token for the connection. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, "createTime": "A String", # Optional. Timestamp when the access token was created. "expiry": "A String", # Optional. Time in seconds when the access token expires. "refreshToken": { # EUASecret provides a reference to entries in Secret Manager. # Optional. Refresh token for the connection. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, }, "redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange. "scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow. "A String", ], }, "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials. "clientId": "A String", # The client identifier. "clientSecret": { # EUASecret provides a reference to entries in Secret Manager. # Required. string value or secret version containing the client secret. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, }, "oauth2JwtBearer": { # 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. # Oauth2JwtBearer. "clientKey": { # EUASecret provides a reference to entries in Secret Manager. # Required. secret version/value 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/*/strings/*/versions/*`. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, "jwtClaims": { # JWT claims used for the jwt-bearer authorization grant. # JwtClaims providers fields to generate the token. "audience": "A String", # Value for the "aud" claim. "issuer": "A String", # Value for the "iss" claim. "subject": "A String", # Value for the "sub" claim. }, }, "sshPublicKey": { # Parameters to support Ssh public key Authentication. # SSH Public Key. "certType": "A String", # Format of SSH Client cert. "sshClientCert": { # EUASecret provides a reference to entries in Secret Manager. # Required. SSH Client Cert. It should contain both public and private key. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, "sshClientCertPass": { # EUASecret provides a reference to entries in Secret Manager. # Required. Password (passphrase) for ssh client certificate if it has one. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, "username": "A String", # The user account used to authenticate. }, "userPassword": { # Parameters to support Username and Password Authentication. # UserPassword. "password": { # EUASecret provides a reference to entries in Secret Manager. # Required. string value or secret version reference containing the password. "secretValue": "A String", # Optional. The plain string value of the secret. "secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, "username": "A String", # Username. }, }, "labels": [ # Optional. Labels for the EndUserAuthentication. "A String", ], "name": "A String", # Required. Identifier. Resource name of the EndUserAuthentication. Format: projects/{project}/locations/{location}/connections/{connection}/endUserAuthentications/{end_user_authentication} "notifyEndpointDestination": { # Message for NotifyEndpointDestination Destination to hit when the refresh token is expired. # Optional. The destination to hit when we receive an event "endpoint": { # Endpoint message includes details of the Destination endpoint. # Optional. OPTION 1: Hit an endpoint when the refresh token is expired. "endpointUri": "A String", # Required. The URI of the Endpoint. "headers": [ # Optional. List of Header to be added to the Endpoint. { # Header details for a given header to be added to Endpoint. "key": "A String", # Required. Key of Header. "value": "A String", # Required. Value of Header. }, ], }, "serviceAccount": "A String", # Required. Service account needed for runtime plane to notify the backend. "type": "A String", # Required. type of the destination }, "roles": [ # Optional. Roles for the EndUserAuthentication. "A String", ], "status": { # EndUserAuthentication Status denotes the status of the EndUserAuthentication resource. # Optional. Status of the EndUserAuthentication. "description": "A String", # Output only. Description of the state. "state": "A String", # Output only. State of Event Subscription resource. }, "updateTime": "A String", # Output only. Updated time. "userId": "A String", # Optional. The user id of the user. } updateMask: string, Required. The list of fields to update. A field will be overwritten if it is in the mask. You can modify only the fields listed below. To update the EndUserAuthentication details: * `notify_endpoint_destination` x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # This resource represents a long-running operation that is the result of a network API call. "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { "a_key": "", # Properties of the object. Contains field @type with type URL. }, ], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. "a_key": "", # Properties of the object. Contains field @type with type URL. }, "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. "a_key": "", # Properties of the object. Contains field @type with type URL. }, }