Documentation ¶
Overview ¶
Package iap provides access to the Cloud Identity-Aware Proxy API.
For product documentation, see: https://cloud.google.com/iap
Creating a client ¶
Usage example:
import "google.golang.org/api/iap/v1" ... ctx := context.Background() iapService, err := iap.NewService(ctx)
In this example, Google Application Default Credentials are used for authentication.
For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.
Other authentication options ¶
To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:
iapService, err := iap.NewService(ctx, option.WithAPIKey("AIza..."))
To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:
config := &oauth2.Config{...} // ... token, err := config.Exchange(ctx, ...) iapService, err := iap.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
See https://godoc.org/google.golang.org/api/option/ for details on options.
Index ¶
- Constants
- type AccessSettings
- type ApplicationSettings
- type Binding
- type Brand
- type CorsSettings
- type CsmSettings
- type Empty
- type Expr
- type GcipSettings
- type GetIamPolicyRequest
- type GetPolicyOptions
- type IapSettings
- type IdentityAwareProxyClient
- type ListBrandsResponse
- type ListIdentityAwareProxyClientsResponse
- type OAuthSettings
- type Policy
- type ProjectsBrandsCreateCall
- func (c *ProjectsBrandsCreateCall) Context(ctx context.Context) *ProjectsBrandsCreateCall
- func (c *ProjectsBrandsCreateCall) Do(opts ...googleapi.CallOption) (*Brand, error)
- func (c *ProjectsBrandsCreateCall) Fields(s ...googleapi.Field) *ProjectsBrandsCreateCall
- func (c *ProjectsBrandsCreateCall) Header() http.Header
- type ProjectsBrandsGetCall
- func (c *ProjectsBrandsGetCall) Context(ctx context.Context) *ProjectsBrandsGetCall
- func (c *ProjectsBrandsGetCall) Do(opts ...googleapi.CallOption) (*Brand, error)
- func (c *ProjectsBrandsGetCall) Fields(s ...googleapi.Field) *ProjectsBrandsGetCall
- func (c *ProjectsBrandsGetCall) Header() http.Header
- func (c *ProjectsBrandsGetCall) IfNoneMatch(entityTag string) *ProjectsBrandsGetCall
- type ProjectsBrandsIdentityAwareProxyClientsCreateCall
- func (c *ProjectsBrandsIdentityAwareProxyClientsCreateCall) Context(ctx context.Context) *ProjectsBrandsIdentityAwareProxyClientsCreateCall
- func (c *ProjectsBrandsIdentityAwareProxyClientsCreateCall) Do(opts ...googleapi.CallOption) (*IdentityAwareProxyClient, error)
- func (c *ProjectsBrandsIdentityAwareProxyClientsCreateCall) Fields(s ...googleapi.Field) *ProjectsBrandsIdentityAwareProxyClientsCreateCall
- func (c *ProjectsBrandsIdentityAwareProxyClientsCreateCall) Header() http.Header
- type ProjectsBrandsIdentityAwareProxyClientsDeleteCall
- func (c *ProjectsBrandsIdentityAwareProxyClientsDeleteCall) Context(ctx context.Context) *ProjectsBrandsIdentityAwareProxyClientsDeleteCall
- func (c *ProjectsBrandsIdentityAwareProxyClientsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *ProjectsBrandsIdentityAwareProxyClientsDeleteCall) Fields(s ...googleapi.Field) *ProjectsBrandsIdentityAwareProxyClientsDeleteCall
- func (c *ProjectsBrandsIdentityAwareProxyClientsDeleteCall) Header() http.Header
- type ProjectsBrandsIdentityAwareProxyClientsGetCall
- func (c *ProjectsBrandsIdentityAwareProxyClientsGetCall) Context(ctx context.Context) *ProjectsBrandsIdentityAwareProxyClientsGetCall
- func (c *ProjectsBrandsIdentityAwareProxyClientsGetCall) Do(opts ...googleapi.CallOption) (*IdentityAwareProxyClient, error)
- func (c *ProjectsBrandsIdentityAwareProxyClientsGetCall) Fields(s ...googleapi.Field) *ProjectsBrandsIdentityAwareProxyClientsGetCall
- func (c *ProjectsBrandsIdentityAwareProxyClientsGetCall) Header() http.Header
- func (c *ProjectsBrandsIdentityAwareProxyClientsGetCall) IfNoneMatch(entityTag string) *ProjectsBrandsIdentityAwareProxyClientsGetCall
- type ProjectsBrandsIdentityAwareProxyClientsListCall
- func (c *ProjectsBrandsIdentityAwareProxyClientsListCall) Context(ctx context.Context) *ProjectsBrandsIdentityAwareProxyClientsListCall
- func (c *ProjectsBrandsIdentityAwareProxyClientsListCall) Do(opts ...googleapi.CallOption) (*ListIdentityAwareProxyClientsResponse, error)
- func (c *ProjectsBrandsIdentityAwareProxyClientsListCall) Fields(s ...googleapi.Field) *ProjectsBrandsIdentityAwareProxyClientsListCall
- func (c *ProjectsBrandsIdentityAwareProxyClientsListCall) Header() http.Header
- func (c *ProjectsBrandsIdentityAwareProxyClientsListCall) IfNoneMatch(entityTag string) *ProjectsBrandsIdentityAwareProxyClientsListCall
- func (c *ProjectsBrandsIdentityAwareProxyClientsListCall) PageSize(pageSize int64) *ProjectsBrandsIdentityAwareProxyClientsListCall
- func (c *ProjectsBrandsIdentityAwareProxyClientsListCall) PageToken(pageToken string) *ProjectsBrandsIdentityAwareProxyClientsListCall
- func (c *ProjectsBrandsIdentityAwareProxyClientsListCall) Pages(ctx context.Context, f func(*ListIdentityAwareProxyClientsResponse) error) error
- type ProjectsBrandsIdentityAwareProxyClientsResetSecretCall
- func (c *ProjectsBrandsIdentityAwareProxyClientsResetSecretCall) Context(ctx context.Context) *ProjectsBrandsIdentityAwareProxyClientsResetSecretCall
- func (c *ProjectsBrandsIdentityAwareProxyClientsResetSecretCall) Do(opts ...googleapi.CallOption) (*IdentityAwareProxyClient, error)
- func (c *ProjectsBrandsIdentityAwareProxyClientsResetSecretCall) Fields(s ...googleapi.Field) *ProjectsBrandsIdentityAwareProxyClientsResetSecretCall
- func (c *ProjectsBrandsIdentityAwareProxyClientsResetSecretCall) Header() http.Header
- type ProjectsBrandsIdentityAwareProxyClientsService
- func (r *ProjectsBrandsIdentityAwareProxyClientsService) Create(parent string, identityawareproxyclient *IdentityAwareProxyClient) *ProjectsBrandsIdentityAwareProxyClientsCreateCall
- func (r *ProjectsBrandsIdentityAwareProxyClientsService) Delete(name string) *ProjectsBrandsIdentityAwareProxyClientsDeleteCall
- func (r *ProjectsBrandsIdentityAwareProxyClientsService) Get(name string) *ProjectsBrandsIdentityAwareProxyClientsGetCall
- func (r *ProjectsBrandsIdentityAwareProxyClientsService) List(parent string) *ProjectsBrandsIdentityAwareProxyClientsListCall
- func (r *ProjectsBrandsIdentityAwareProxyClientsService) ResetSecret(name string, ...) *ProjectsBrandsIdentityAwareProxyClientsResetSecretCall
- type ProjectsBrandsListCall
- func (c *ProjectsBrandsListCall) Context(ctx context.Context) *ProjectsBrandsListCall
- func (c *ProjectsBrandsListCall) Do(opts ...googleapi.CallOption) (*ListBrandsResponse, error)
- func (c *ProjectsBrandsListCall) Fields(s ...googleapi.Field) *ProjectsBrandsListCall
- func (c *ProjectsBrandsListCall) Header() http.Header
- func (c *ProjectsBrandsListCall) IfNoneMatch(entityTag string) *ProjectsBrandsListCall
- type ProjectsBrandsService
- type ProjectsService
- type ResetIdentityAwareProxyClientSecretRequest
- type Service
- type SetIamPolicyRequest
- type TestIamPermissionsRequest
- type TestIamPermissionsResponse
- type V1GetIamPolicyCall
- type V1GetIapSettingsCall
- func (c *V1GetIapSettingsCall) Context(ctx context.Context) *V1GetIapSettingsCall
- func (c *V1GetIapSettingsCall) Do(opts ...googleapi.CallOption) (*IapSettings, error)
- func (c *V1GetIapSettingsCall) Fields(s ...googleapi.Field) *V1GetIapSettingsCall
- func (c *V1GetIapSettingsCall) Header() http.Header
- func (c *V1GetIapSettingsCall) IfNoneMatch(entityTag string) *V1GetIapSettingsCall
- type V1Service
- func (r *V1Service) GetIamPolicy(resource string, getiampolicyrequest *GetIamPolicyRequest) *V1GetIamPolicyCall
- func (r *V1Service) GetIapSettings(name string) *V1GetIapSettingsCall
- func (r *V1Service) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *V1SetIamPolicyCall
- func (r *V1Service) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *V1TestIamPermissionsCall
- func (r *V1Service) UpdateIapSettings(name string, iapsettings *IapSettings) *V1UpdateIapSettingsCall
- type V1SetIamPolicyCall
- type V1TestIamPermissionsCall
- func (c *V1TestIamPermissionsCall) Context(ctx context.Context) *V1TestIamPermissionsCall
- func (c *V1TestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error)
- func (c *V1TestIamPermissionsCall) Fields(s ...googleapi.Field) *V1TestIamPermissionsCall
- func (c *V1TestIamPermissionsCall) Header() http.Header
- type V1UpdateIapSettingsCall
- func (c *V1UpdateIapSettingsCall) Context(ctx context.Context) *V1UpdateIapSettingsCall
- func (c *V1UpdateIapSettingsCall) Do(opts ...googleapi.CallOption) (*IapSettings, error)
- func (c *V1UpdateIapSettingsCall) Fields(s ...googleapi.Field) *V1UpdateIapSettingsCall
- func (c *V1UpdateIapSettingsCall) Header() http.Header
- func (c *V1UpdateIapSettingsCall) UpdateMask(updateMask string) *V1UpdateIapSettingsCall
Constants ¶
const (
// View and manage your data across Google Cloud Platform services
CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)
OAuth2 scopes used by this API.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccessSettings ¶
type AccessSettings struct { // CorsSettings: Configuration to allow cross-origin requests via IAP. CorsSettings *CorsSettings `json:"corsSettings,omitempty"` // GcipSettings: GCIP claims and endpoint configurations for 3p identity // providers. GcipSettings *GcipSettings `json:"gcipSettings,omitempty"` // OauthSettings: Settings to configure IAP's OAuth behavior. OauthSettings *OAuthSettings `json:"oauthSettings,omitempty"` // ForceSendFields is a list of field names (e.g. "CorsSettings") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CorsSettings") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AccessSettings: Access related settings for IAP protected apps.
func (*AccessSettings) MarshalJSON ¶
func (s *AccessSettings) MarshalJSON() ([]byte, error)
type ApplicationSettings ¶
type ApplicationSettings struct { // CsmSettings: Settings to configure IAP's behavior for a CSM mesh. CsmSettings *CsmSettings `json:"csmSettings,omitempty"` // ForceSendFields is a list of field names (e.g. "CsmSettings") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CsmSettings") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ApplicationSettings: Wrapper over application specific settings for IAP.
func (*ApplicationSettings) MarshalJSON ¶
func (s *ApplicationSettings) MarshalJSON() ([]byte, error)
type Binding ¶
type Binding struct { // Condition: The condition that is associated with this binding. // NOTE: An unsatisfied condition will not allow user access via // current // binding. Different bindings, including their conditions, are // examined // independently. Condition *Expr `json:"condition,omitempty"` // Members: Specifies the identities requesting access for a Cloud // Platform resource. // `members` can have the following values: // // * `allUsers`: A special identifier that represents anyone who is // on the internet; with or without a Google account. // // * `allAuthenticatedUsers`: A special identifier that represents // anyone // who is authenticated with a Google account or a service // account. // // * `user:{emailid}`: An email address that represents a specific // Google // account. For example, `alice@example.com` . // // // * `serviceAccount:{emailid}`: An email address that represents a // service // account. For example, // `my-other-app@appspot.gserviceaccount.com`. // // * `group:{emailid}`: An email address that represents a Google // group. // For example, `admins@example.com`. // // * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus // unique // identifier) representing a user that has been recently deleted. // For // example, `alice@example.com?uid=123456789012345678901`. If the // user is // recovered, this value reverts to `user:{emailid}` and the // recovered user // retains the role in the binding. // // * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address // (plus // unique identifier) representing a service account that has been // recently // deleted. For example, // // `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. // // If the service account is undeleted, this value reverts to // `serviceAccount:{emailid}` and the undeleted service account // retains the // role in the binding. // // * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus // unique // identifier) representing a Google group that has been recently // deleted. For example, // `admins@example.com?uid=123456789012345678901`. If // the group is recovered, this value reverts to `group:{emailid}` // and the // recovered group retains the role in the binding. // // // * `domain:{domain}`: The G Suite domain (primary) that represents all // the // users of that domain. For example, `google.com` or // `example.com`. // // Members []string `json:"members,omitempty"` // Role: Role that is assigned to `members`. // For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Role string `json:"role,omitempty"` // ForceSendFields is a list of field names (e.g. "Condition") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Condition") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Binding: Associates `members` with a `role`.
func (*Binding) MarshalJSON ¶
type Brand ¶
type Brand struct { // ApplicationTitle: Application name displayed on OAuth consent screen. ApplicationTitle string `json:"applicationTitle,omitempty"` // Name: Output only. Identifier of the brand. // NOTE: GCP project number achieves the same brand identification // purpose as // only one brand per project can be created. Name string `json:"name,omitempty"` // OrgInternalOnly: Output only. Whether the brand is only intended for // usage inside the // GSuite organization only. OrgInternalOnly bool `json:"orgInternalOnly,omitempty"` // SupportEmail: Support email displayed on the OAuth consent screen. SupportEmail string `json:"supportEmail,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "ApplicationTitle") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ApplicationTitle") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
Brand: OAuth brand data. NOTE: Only contains a portion of the data that describes a brand.
func (*Brand) MarshalJSON ¶
type CorsSettings ¶
type CorsSettings struct { // AllowHttpOptions: Configuration to allow HTTP OPTIONS calls to skip // authorization. If // undefined, IAP will not apply any special logic to OPTIONS requests. AllowHttpOptions bool `json:"allowHttpOptions,omitempty"` // ForceSendFields is a list of field names (e.g. "AllowHttpOptions") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AllowHttpOptions") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
CorsSettings: Allows customers to configure HTTP request paths that'll allow HTTP OPTIONS call to bypass authentication and authorization.
func (*CorsSettings) MarshalJSON ¶
func (s *CorsSettings) MarshalJSON() ([]byte, error)
type CsmSettings ¶
type CsmSettings struct { // RctokenAud: Audience claim set in the generated RCToken. This value // is not validated by // IAP. RctokenAud string `json:"rctokenAud,omitempty"` // ForceSendFields is a list of field names (e.g. "RctokenAud") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "RctokenAud") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
CsmSettings: Configuration for RCTokens generated for CSM workloads protected by IAP. RCTokens are IAP generated JWTs that can be verified at the application. The RCToken is primarily used for ISTIO deployments, and can be scoped to a single mesh by configuring the audience field accordingly
func (*CsmSettings) MarshalJSON ¶
func (s *CsmSettings) MarshalJSON() ([]byte, error)
type Empty ¶
type Empty struct { // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` }
Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
service Foo { rpc Bar(google.protobuf.Empty) returns
(google.protobuf.Empty);
}
The JSON representation for `Empty` is empty JSON object `{}`.
type Expr ¶
type Expr struct { // Description: Optional. Description of the expression. This is a // longer text which // describes the expression, e.g. when hovered over it in a UI. Description string `json:"description,omitempty"` // Expression: Textual representation of an expression in Common // Expression Language // syntax. Expression string `json:"expression,omitempty"` // Location: Optional. String indicating the location of the expression // for error // reporting, e.g. a file name and a position in the file. Location string `json:"location,omitempty"` // Title: Optional. Title for the expression, i.e. a short string // describing // its purpose. This can be used e.g. in UIs which allow to enter // the // expression. Title string `json:"title,omitempty"` // ForceSendFields is a list of field names (e.g. "Description") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Description") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Expr: Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.
Example (Comparison):
title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"
Example (Equality):
title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner ==
request.auth.claims.email"
Example (Logic):
title: "Public documents" description: "Determine whether the document should be publicly
visible"
expression: "document.type != 'private' && document.type !=
'internal'"
Example (Data Manipulation):
title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' +
string(document.create_time)"
The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
func (*Expr) MarshalJSON ¶
type GcipSettings ¶
type GcipSettings struct { // LoginPageUri: Login page URI associated with the GCIP // tenants. // Typically, all resources within the same project share the same login // page, // though it could be overridden at the sub resource level. LoginPageUri string `json:"loginPageUri,omitempty"` // TenantIds: GCIP tenant ids that are linked to the IAP // resource. // tenant_ids could be a string beginning with a number character to // indicate // authenticating with GCIP tenant flow, or in the format of // _<ProjectNumber> // to indicate authenticating with GCIP agent flow. // If agent flow is used, tenant_ids should only contain one single // element, // while for tenant flow, tenant_ids can contain multiple elements. TenantIds []string `json:"tenantIds,omitempty"` // ForceSendFields is a list of field names (e.g. "LoginPageUri") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "LoginPageUri") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GcipSettings: Allows customers to configure tenant_id for GCIP instance per-app.
func (*GcipSettings) MarshalJSON ¶
func (s *GcipSettings) MarshalJSON() ([]byte, error)
type GetIamPolicyRequest ¶
type GetIamPolicyRequest struct { // Options: OPTIONAL: A `GetPolicyOptions` object for specifying options // to // `GetIamPolicy`. This field is only used by Cloud IAM. Options *GetPolicyOptions `json:"options,omitempty"` // ForceSendFields is a list of field names (e.g. "Options") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Options") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GetIamPolicyRequest: Request message for `GetIamPolicy` method.
func (*GetIamPolicyRequest) MarshalJSON ¶
func (s *GetIamPolicyRequest) MarshalJSON() ([]byte, error)
type GetPolicyOptions ¶
type GetPolicyOptions struct { // RequestedPolicyVersion: Optional. The policy format version to be // returned. // // Valid values are 0, 1, and 3. Requests specifying an invalid value // will be // rejected. // // Requests for policies with any conditional bindings must specify // version 3. // Policies without any conditional bindings may specify any valid value // or // leave the field unset. RequestedPolicyVersion int64 `json:"requestedPolicyVersion,omitempty"` // ForceSendFields is a list of field names (e.g. // "RequestedPolicyVersion") to unconditionally include in API requests. // By default, fields with empty values are omitted from API requests. // However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "RequestedPolicyVersion") // to include in API requests with the JSON null value. By default, // fields with empty values are omitted from API requests. However, any // field with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GetPolicyOptions: Encapsulates settings provided to GetIamPolicy.
func (*GetPolicyOptions) MarshalJSON ¶
func (s *GetPolicyOptions) MarshalJSON() ([]byte, error)
type IapSettings ¶
type IapSettings struct { // AccessSettings: Top level wrapper for all access related setting in // IAP AccessSettings *AccessSettings `json:"accessSettings,omitempty"` // ApplicationSettings: Top level wrapper for all application related // settings in IAP ApplicationSettings *ApplicationSettings `json:"applicationSettings,omitempty"` // Name: Required. The resource name of the IAP protected resource. Name string `json:"name,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "AccessSettings") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AccessSettings") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
IapSettings: The IAP configurable settings.
func (*IapSettings) MarshalJSON ¶
func (s *IapSettings) MarshalJSON() ([]byte, error)
type IdentityAwareProxyClient ¶
type IdentityAwareProxyClient struct { // DisplayName: Human-friendly name given to the OAuth client. DisplayName string `json:"displayName,omitempty"` // Name: Output only. Unique identifier of the OAuth client. Name string `json:"name,omitempty"` // Secret: Output only. Client secret of the OAuth client. Secret string `json:"secret,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "DisplayName") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DisplayName") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
IdentityAwareProxyClient: Contains the data that describes an Identity Aware Proxy owned client.
func (*IdentityAwareProxyClient) MarshalJSON ¶
func (s *IdentityAwareProxyClient) MarshalJSON() ([]byte, error)
type ListBrandsResponse ¶
type ListBrandsResponse struct { // Brands: Brands existing in the project. Brands []*Brand `json:"brands,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Brands") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Brands") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ListBrandsResponse: Response message for ListBrands.
func (*ListBrandsResponse) MarshalJSON ¶
func (s *ListBrandsResponse) MarshalJSON() ([]byte, error)
type ListIdentityAwareProxyClientsResponse ¶
type ListIdentityAwareProxyClientsResponse struct { // IdentityAwareProxyClients: Clients existing in the brand. IdentityAwareProxyClients []*IdentityAwareProxyClient `json:"identityAwareProxyClients,omitempty"` // NextPageToken: A token, which can be send as `page_token` to retrieve // the next page. // If this field is omitted, there are no subsequent pages. NextPageToken string `json:"nextPageToken,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. // "IdentityAwareProxyClients") to unconditionally include in API // requests. By default, fields with empty values are omitted from API // requests. However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. // "IdentityAwareProxyClients") to include in API requests with the JSON // null value. By default, fields with empty values are omitted from API // requests. However, any field with an empty value appearing in // NullFields will be sent to the server as null. It is an error if a // field in this list has a non-empty value. This may be used to include // null fields in Patch requests. NullFields []string `json:"-"` }
ListIdentityAwareProxyClientsResponse: Response message for ListIdentityAwareProxyClients.
func (*ListIdentityAwareProxyClientsResponse) MarshalJSON ¶
func (s *ListIdentityAwareProxyClientsResponse) MarshalJSON() ([]byte, error)
type OAuthSettings ¶
type OAuthSettings struct { // ClientId: OAuth 2.0 client ID used in the OAuth flow to generate an // access token. If // this field is set, you can skip obtaining the OAuth credentials in // this // step: // https://developers.google.com/identity/protocols/OAuth2?hl= // en_US#1.-obtain-oauth-2.0-credentials-from-the-google-api-console. // How // ever, this could allow for client sharing. The risks of client // sharing // are outlined // here: // https://cloud.google.com/iap/docs/sharing-oauth-clients#risks. ClientId string `json:"clientId,omitempty"` // LoginHint: Domain hint to send as hd=? parameter in OAuth request // flow. Enables // redirect to primary IDP by skipping Google's login // screen. // https://developers.google.com/identity/protocols/OpenIDConnect // #hd-param // Note: IAP does not verify that the id token's hd claim matches this // value // since access behavior is managed by IAM policies. LoginHint string `json:"loginHint,omitempty"` // ForceSendFields is a list of field names (e.g. "ClientId") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ClientId") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
OAuthSettings: Configuration for OAuth login&consent flow behavior as well as for OAuth Credentials.
func (*OAuthSettings) MarshalJSON ¶
func (s *OAuthSettings) MarshalJSON() ([]byte, error)
type Policy ¶
type Policy struct { // Bindings: Associates a list of `members` to a `role`. Optionally, may // specify a // `condition` that determines how and when the `bindings` are applied. // Each // of the `bindings` must contain at least one member. Bindings []*Binding `json:"bindings,omitempty"` // Etag: `etag` is used for optimistic concurrency control as a way to // help // prevent simultaneous updates of a policy from overwriting each // other. // It is strongly suggested that systems make use of the `etag` in // the // read-modify-write cycle to perform policy updates in order to avoid // race // conditions: An `etag` is returned in the response to `getIamPolicy`, // and // systems are expected to put that etag in the request to // `setIamPolicy` to // ensure that their change will be applied to the same version of the // policy. // // **Important:** If you use IAM Conditions, you must include the `etag` // field // whenever you call `setIamPolicy`. If you omit this field, then IAM // allows // you to overwrite a version `3` policy with a version `1` policy, and // all of // the conditions in the version `3` policy are lost. Etag string `json:"etag,omitempty"` // Version: Specifies the format of the policy. // // Valid values are `0`, `1`, and `3`. Requests that specify an invalid // value // are rejected. // // Any operation that affects conditional role bindings must specify // version // `3`. This requirement applies to the following operations: // // * Getting a policy that includes a conditional role binding // * Adding a conditional role binding to a policy // * Changing a conditional role binding in a policy // * Removing any role binding, with or without a condition, from a // policy // that includes conditions // // **Important:** If you use IAM Conditions, you must include the `etag` // field // whenever you call `setIamPolicy`. If you omit this field, then IAM // allows // you to overwrite a version `3` policy with a version `1` policy, and // all of // the conditions in the version `3` policy are lost. // // If a policy does not include any conditions, operations on that // policy may // specify any valid version or leave the field unset. Version int64 `json:"version,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Bindings") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Bindings") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Policy: An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.
A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role.
Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both.
**JSON example:**
{ "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com",
"serviceAccount:my-project-id@appspot.gserviceaccount.com"
] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time <
timestamp('2020-10-01T00:00:00.000Z')",
} } ], "etag": "BwWWja0YfJA=", "version": 3 }
**YAML example:**
bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time <
timestamp('2020-10-01T00:00:00.000Z')
- etag: BwWWja0YfJA=
- version: 3
For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
func (*Policy) MarshalJSON ¶
type ProjectsBrandsCreateCall ¶
type ProjectsBrandsCreateCall struct {
// contains filtered or unexported fields
}
func (*ProjectsBrandsCreateCall) Context ¶
func (c *ProjectsBrandsCreateCall) Context(ctx context.Context) *ProjectsBrandsCreateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsBrandsCreateCall) Do ¶
func (c *ProjectsBrandsCreateCall) Do(opts ...googleapi.CallOption) (*Brand, error)
Do executes the "iap.projects.brands.create" call. Exactly one of *Brand or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Brand.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsBrandsCreateCall) Fields ¶
func (c *ProjectsBrandsCreateCall) Fields(s ...googleapi.Field) *ProjectsBrandsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsBrandsCreateCall) Header ¶
func (c *ProjectsBrandsCreateCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsBrandsGetCall ¶
type ProjectsBrandsGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsBrandsGetCall) Context ¶
func (c *ProjectsBrandsGetCall) Context(ctx context.Context) *ProjectsBrandsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsBrandsGetCall) Do ¶
func (c *ProjectsBrandsGetCall) Do(opts ...googleapi.CallOption) (*Brand, error)
Do executes the "iap.projects.brands.get" call. Exactly one of *Brand or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Brand.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsBrandsGetCall) Fields ¶
func (c *ProjectsBrandsGetCall) Fields(s ...googleapi.Field) *ProjectsBrandsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsBrandsGetCall) Header ¶
func (c *ProjectsBrandsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsBrandsGetCall) IfNoneMatch ¶
func (c *ProjectsBrandsGetCall) IfNoneMatch(entityTag string) *ProjectsBrandsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type ProjectsBrandsIdentityAwareProxyClientsCreateCall ¶
type ProjectsBrandsIdentityAwareProxyClientsCreateCall struct {
// contains filtered or unexported fields
}
func (*ProjectsBrandsIdentityAwareProxyClientsCreateCall) Context ¶
func (c *ProjectsBrandsIdentityAwareProxyClientsCreateCall) Context(ctx context.Context) *ProjectsBrandsIdentityAwareProxyClientsCreateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsBrandsIdentityAwareProxyClientsCreateCall) Do ¶
func (c *ProjectsBrandsIdentityAwareProxyClientsCreateCall) Do(opts ...googleapi.CallOption) (*IdentityAwareProxyClient, error)
Do executes the "iap.projects.brands.identityAwareProxyClients.create" call. Exactly one of *IdentityAwareProxyClient or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *IdentityAwareProxyClient.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsBrandsIdentityAwareProxyClientsCreateCall) Fields ¶
func (c *ProjectsBrandsIdentityAwareProxyClientsCreateCall) Fields(s ...googleapi.Field) *ProjectsBrandsIdentityAwareProxyClientsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsBrandsIdentityAwareProxyClientsCreateCall) Header ¶
func (c *ProjectsBrandsIdentityAwareProxyClientsCreateCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsBrandsIdentityAwareProxyClientsDeleteCall ¶
type ProjectsBrandsIdentityAwareProxyClientsDeleteCall struct {
// contains filtered or unexported fields
}
func (*ProjectsBrandsIdentityAwareProxyClientsDeleteCall) Context ¶
func (c *ProjectsBrandsIdentityAwareProxyClientsDeleteCall) Context(ctx context.Context) *ProjectsBrandsIdentityAwareProxyClientsDeleteCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsBrandsIdentityAwareProxyClientsDeleteCall) Do ¶
func (c *ProjectsBrandsIdentityAwareProxyClientsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "iap.projects.brands.identityAwareProxyClients.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsBrandsIdentityAwareProxyClientsDeleteCall) Fields ¶
func (c *ProjectsBrandsIdentityAwareProxyClientsDeleteCall) Fields(s ...googleapi.Field) *ProjectsBrandsIdentityAwareProxyClientsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsBrandsIdentityAwareProxyClientsDeleteCall) Header ¶
func (c *ProjectsBrandsIdentityAwareProxyClientsDeleteCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsBrandsIdentityAwareProxyClientsGetCall ¶
type ProjectsBrandsIdentityAwareProxyClientsGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsBrandsIdentityAwareProxyClientsGetCall) Context ¶
func (c *ProjectsBrandsIdentityAwareProxyClientsGetCall) Context(ctx context.Context) *ProjectsBrandsIdentityAwareProxyClientsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsBrandsIdentityAwareProxyClientsGetCall) Do ¶
func (c *ProjectsBrandsIdentityAwareProxyClientsGetCall) Do(opts ...googleapi.CallOption) (*IdentityAwareProxyClient, error)
Do executes the "iap.projects.brands.identityAwareProxyClients.get" call. Exactly one of *IdentityAwareProxyClient or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *IdentityAwareProxyClient.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsBrandsIdentityAwareProxyClientsGetCall) Fields ¶
func (c *ProjectsBrandsIdentityAwareProxyClientsGetCall) Fields(s ...googleapi.Field) *ProjectsBrandsIdentityAwareProxyClientsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsBrandsIdentityAwareProxyClientsGetCall) Header ¶
func (c *ProjectsBrandsIdentityAwareProxyClientsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsBrandsIdentityAwareProxyClientsGetCall) IfNoneMatch ¶
func (c *ProjectsBrandsIdentityAwareProxyClientsGetCall) IfNoneMatch(entityTag string) *ProjectsBrandsIdentityAwareProxyClientsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type ProjectsBrandsIdentityAwareProxyClientsListCall ¶
type ProjectsBrandsIdentityAwareProxyClientsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsBrandsIdentityAwareProxyClientsListCall) Context ¶
func (c *ProjectsBrandsIdentityAwareProxyClientsListCall) Context(ctx context.Context) *ProjectsBrandsIdentityAwareProxyClientsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsBrandsIdentityAwareProxyClientsListCall) Do ¶
func (c *ProjectsBrandsIdentityAwareProxyClientsListCall) Do(opts ...googleapi.CallOption) (*ListIdentityAwareProxyClientsResponse, error)
Do executes the "iap.projects.brands.identityAwareProxyClients.list" call. Exactly one of *ListIdentityAwareProxyClientsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListIdentityAwareProxyClientsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsBrandsIdentityAwareProxyClientsListCall) Fields ¶
func (c *ProjectsBrandsIdentityAwareProxyClientsListCall) Fields(s ...googleapi.Field) *ProjectsBrandsIdentityAwareProxyClientsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsBrandsIdentityAwareProxyClientsListCall) Header ¶
func (c *ProjectsBrandsIdentityAwareProxyClientsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsBrandsIdentityAwareProxyClientsListCall) IfNoneMatch ¶
func (c *ProjectsBrandsIdentityAwareProxyClientsListCall) IfNoneMatch(entityTag string) *ProjectsBrandsIdentityAwareProxyClientsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ProjectsBrandsIdentityAwareProxyClientsListCall) PageSize ¶
func (c *ProjectsBrandsIdentityAwareProxyClientsListCall) PageSize(pageSize int64) *ProjectsBrandsIdentityAwareProxyClientsListCall
PageSize sets the optional parameter "pageSize": The maximum number of clients to return. The service may return fewer than this value. If unspecified, at most 100 clients will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
func (*ProjectsBrandsIdentityAwareProxyClientsListCall) PageToken ¶
func (c *ProjectsBrandsIdentityAwareProxyClientsListCall) PageToken(pageToken string) *ProjectsBrandsIdentityAwareProxyClientsListCall
PageToken sets the optional parameter "pageToken": A page token, received from a previous `ListIdentityAwareProxyClients` call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to `ListIdentityAwareProxyClients` must match the call that provided the page token.
func (*ProjectsBrandsIdentityAwareProxyClientsListCall) Pages ¶
func (c *ProjectsBrandsIdentityAwareProxyClientsListCall) Pages(ctx context.Context, f func(*ListIdentityAwareProxyClientsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type ProjectsBrandsIdentityAwareProxyClientsResetSecretCall ¶
type ProjectsBrandsIdentityAwareProxyClientsResetSecretCall struct {
// contains filtered or unexported fields
}
func (*ProjectsBrandsIdentityAwareProxyClientsResetSecretCall) Context ¶
func (c *ProjectsBrandsIdentityAwareProxyClientsResetSecretCall) Context(ctx context.Context) *ProjectsBrandsIdentityAwareProxyClientsResetSecretCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsBrandsIdentityAwareProxyClientsResetSecretCall) Do ¶
func (c *ProjectsBrandsIdentityAwareProxyClientsResetSecretCall) Do(opts ...googleapi.CallOption) (*IdentityAwareProxyClient, error)
Do executes the "iap.projects.brands.identityAwareProxyClients.resetSecret" call. Exactly one of *IdentityAwareProxyClient or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *IdentityAwareProxyClient.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsBrandsIdentityAwareProxyClientsResetSecretCall) Fields ¶
func (c *ProjectsBrandsIdentityAwareProxyClientsResetSecretCall) Fields(s ...googleapi.Field) *ProjectsBrandsIdentityAwareProxyClientsResetSecretCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsBrandsIdentityAwareProxyClientsResetSecretCall) Header ¶
func (c *ProjectsBrandsIdentityAwareProxyClientsResetSecretCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsBrandsIdentityAwareProxyClientsService ¶
type ProjectsBrandsIdentityAwareProxyClientsService struct {
// contains filtered or unexported fields
}
func NewProjectsBrandsIdentityAwareProxyClientsService ¶
func NewProjectsBrandsIdentityAwareProxyClientsService(s *Service) *ProjectsBrandsIdentityAwareProxyClientsService
func (*ProjectsBrandsIdentityAwareProxyClientsService) Create ¶
func (r *ProjectsBrandsIdentityAwareProxyClientsService) Create(parent string, identityawareproxyclient *IdentityAwareProxyClient) *ProjectsBrandsIdentityAwareProxyClientsCreateCall
Create: Creates an Identity Aware Proxy (IAP) OAuth client. The client is owned by IAP. Requires that the brand for the project exists and that it is set for internal-only use.
func (*ProjectsBrandsIdentityAwareProxyClientsService) Delete ¶
func (r *ProjectsBrandsIdentityAwareProxyClientsService) Delete(name string) *ProjectsBrandsIdentityAwareProxyClientsDeleteCall
Delete: Deletes an Identity Aware Proxy (IAP) OAuth client. Useful for removing obsolete clients, managing the number of clients in a given project, and cleaning up after tests. Requires that the client is owned by IAP.
func (*ProjectsBrandsIdentityAwareProxyClientsService) Get ¶
func (r *ProjectsBrandsIdentityAwareProxyClientsService) Get(name string) *ProjectsBrandsIdentityAwareProxyClientsGetCall
Get: Retrieves an Identity Aware Proxy (IAP) OAuth client. Requires that the client is owned by IAP.
func (*ProjectsBrandsIdentityAwareProxyClientsService) List ¶
func (r *ProjectsBrandsIdentityAwareProxyClientsService) List(parent string) *ProjectsBrandsIdentityAwareProxyClientsListCall
List: Lists the existing clients for the brand.
func (*ProjectsBrandsIdentityAwareProxyClientsService) ResetSecret ¶
func (r *ProjectsBrandsIdentityAwareProxyClientsService) ResetSecret(name string, resetidentityawareproxyclientsecretrequest *ResetIdentityAwareProxyClientSecretRequest) *ProjectsBrandsIdentityAwareProxyClientsResetSecretCall
ResetSecret: Resets an Identity Aware Proxy (IAP) OAuth client secret. Useful if the secret was compromised. Requires that the client is owned by IAP.
type ProjectsBrandsListCall ¶
type ProjectsBrandsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsBrandsListCall) Context ¶
func (c *ProjectsBrandsListCall) Context(ctx context.Context) *ProjectsBrandsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsBrandsListCall) Do ¶
func (c *ProjectsBrandsListCall) Do(opts ...googleapi.CallOption) (*ListBrandsResponse, error)
Do executes the "iap.projects.brands.list" call. Exactly one of *ListBrandsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListBrandsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsBrandsListCall) Fields ¶
func (c *ProjectsBrandsListCall) Fields(s ...googleapi.Field) *ProjectsBrandsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsBrandsListCall) Header ¶
func (c *ProjectsBrandsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsBrandsListCall) IfNoneMatch ¶
func (c *ProjectsBrandsListCall) IfNoneMatch(entityTag string) *ProjectsBrandsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type ProjectsBrandsService ¶
type ProjectsBrandsService struct { IdentityAwareProxyClients *ProjectsBrandsIdentityAwareProxyClientsService // contains filtered or unexported fields }
func NewProjectsBrandsService ¶
func NewProjectsBrandsService(s *Service) *ProjectsBrandsService
func (*ProjectsBrandsService) Create ¶
func (r *ProjectsBrandsService) Create(parent string, brand *Brand) *ProjectsBrandsCreateCall
Create: Constructs a new OAuth brand for the project if one does not exist. The created brand is "internal only", meaning that OAuth clients created under it only accept requests from users who belong to the same G Suite organization as the project. The brand is created in an un-reviewed status. NOTE: The "internal only" status can be manually changed in the Google Cloud console. Requires that a brand does not already exist for the project, and that the specified support email is owned by the caller.
func (*ProjectsBrandsService) Get ¶
func (r *ProjectsBrandsService) Get(name string) *ProjectsBrandsGetCall
Get: Retrieves the OAuth brand of the project.
func (*ProjectsBrandsService) List ¶
func (r *ProjectsBrandsService) List(parent string) *ProjectsBrandsListCall
List: Lists the existing brands for the project.
type ProjectsService ¶
type ProjectsService struct { Brands *ProjectsBrandsService // contains filtered or unexported fields }
func NewProjectsService ¶
func NewProjectsService(s *Service) *ProjectsService
type ResetIdentityAwareProxyClientSecretRequest ¶
type ResetIdentityAwareProxyClientSecretRequest struct { }
ResetIdentityAwareProxyClientSecretRequest: The request sent to ResetIdentityAwareProxyClientSecret.
type Service ¶
type Service struct { BasePath string // API endpoint base URL UserAgent string // optional additional User-Agent fragment Projects *ProjectsService V1 *V1Service // contains filtered or unexported fields }
func New
deprecated
New creates a new Service. It uses the provided http.Client for requests.
Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func NewService ¶
NewService creates a new Service.
type SetIamPolicyRequest ¶
type SetIamPolicyRequest struct { // Policy: REQUIRED: The complete policy to be applied to the // `resource`. The size of // the policy is limited to a few 10s of KB. An empty policy is a // valid policy but certain Cloud Platform services (such as // Projects) // might reject them. Policy *Policy `json:"policy,omitempty"` // ForceSendFields is a list of field names (e.g. "Policy") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Policy") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
SetIamPolicyRequest: Request message for `SetIamPolicy` method.
func (*SetIamPolicyRequest) MarshalJSON ¶
func (s *SetIamPolicyRequest) MarshalJSON() ([]byte, error)
type TestIamPermissionsRequest ¶
type TestIamPermissionsRequest struct { // Permissions: The set of permissions to check for the `resource`. // Permissions with // wildcards (such as '*' or 'storage.*') are not allowed. For // more // information see // [IAM // Overview](https://cloud.google.com/iam/docs/overview#permissions). Permissions []string `json:"permissions,omitempty"` // ForceSendFields is a list of field names (e.g. "Permissions") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Permissions") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
TestIamPermissionsRequest: Request message for `TestIamPermissions` method.
func (*TestIamPermissionsRequest) MarshalJSON ¶
func (s *TestIamPermissionsRequest) MarshalJSON() ([]byte, error)
type TestIamPermissionsResponse ¶
type TestIamPermissionsResponse struct { // Permissions: A subset of `TestPermissionsRequest.permissions` that // the caller is // allowed. Permissions []string `json:"permissions,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Permissions") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Permissions") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
TestIamPermissionsResponse: Response message for `TestIamPermissions` method.
func (*TestIamPermissionsResponse) MarshalJSON ¶
func (s *TestIamPermissionsResponse) MarshalJSON() ([]byte, error)
type V1GetIamPolicyCall ¶
type V1GetIamPolicyCall struct {
// contains filtered or unexported fields
}
func (*V1GetIamPolicyCall) Context ¶
func (c *V1GetIamPolicyCall) Context(ctx context.Context) *V1GetIamPolicyCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*V1GetIamPolicyCall) Do ¶
func (c *V1GetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)
Do executes the "iap.getIamPolicy" call. Exactly one of *Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*V1GetIamPolicyCall) Fields ¶
func (c *V1GetIamPolicyCall) Fields(s ...googleapi.Field) *V1GetIamPolicyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*V1GetIamPolicyCall) Header ¶
func (c *V1GetIamPolicyCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type V1GetIapSettingsCall ¶
type V1GetIapSettingsCall struct {
// contains filtered or unexported fields
}
func (*V1GetIapSettingsCall) Context ¶
func (c *V1GetIapSettingsCall) Context(ctx context.Context) *V1GetIapSettingsCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*V1GetIapSettingsCall) Do ¶
func (c *V1GetIapSettingsCall) Do(opts ...googleapi.CallOption) (*IapSettings, error)
Do executes the "iap.getIapSettings" call. Exactly one of *IapSettings or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *IapSettings.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*V1GetIapSettingsCall) Fields ¶
func (c *V1GetIapSettingsCall) Fields(s ...googleapi.Field) *V1GetIapSettingsCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*V1GetIapSettingsCall) Header ¶
func (c *V1GetIapSettingsCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*V1GetIapSettingsCall) IfNoneMatch ¶
func (c *V1GetIapSettingsCall) IfNoneMatch(entityTag string) *V1GetIapSettingsCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type V1Service ¶
type V1Service struct {
// contains filtered or unexported fields
}
func NewV1Service ¶
func (*V1Service) GetIamPolicy ¶
func (r *V1Service) GetIamPolicy(resource string, getiampolicyrequest *GetIamPolicyRequest) *V1GetIamPolicyCall
GetIamPolicy: Gets the access control policy for an Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_ via_the_api
func (*V1Service) GetIapSettings ¶
func (r *V1Service) GetIapSettings(name string) *V1GetIapSettingsCall
GetIapSettings: Gets the IAP settings on a particular IAP protected resource.
func (*V1Service) SetIamPolicy ¶
func (r *V1Service) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *V1SetIamPolicyCall
SetIamPolicy: Sets the access control policy for an Identity-Aware Proxy protected resource. Replaces any existing policy. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_ via_the_api
func (*V1Service) TestIamPermissions ¶
func (r *V1Service) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *V1TestIamPermissionsCall
TestIamPermissions: Returns permissions that a caller has on the Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_ via_the_api
func (*V1Service) UpdateIapSettings ¶
func (r *V1Service) UpdateIapSettings(name string, iapsettings *IapSettings) *V1UpdateIapSettingsCall
UpdateIapSettings: Updates the IAP settings on a particular IAP protected resource. It replaces all fields unless the `update_mask` is set.
type V1SetIamPolicyCall ¶
type V1SetIamPolicyCall struct {
// contains filtered or unexported fields
}
func (*V1SetIamPolicyCall) Context ¶
func (c *V1SetIamPolicyCall) Context(ctx context.Context) *V1SetIamPolicyCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*V1SetIamPolicyCall) Do ¶
func (c *V1SetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)
Do executes the "iap.setIamPolicy" call. Exactly one of *Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*V1SetIamPolicyCall) Fields ¶
func (c *V1SetIamPolicyCall) Fields(s ...googleapi.Field) *V1SetIamPolicyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*V1SetIamPolicyCall) Header ¶
func (c *V1SetIamPolicyCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type V1TestIamPermissionsCall ¶
type V1TestIamPermissionsCall struct {
// contains filtered or unexported fields
}
func (*V1TestIamPermissionsCall) Context ¶
func (c *V1TestIamPermissionsCall) Context(ctx context.Context) *V1TestIamPermissionsCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*V1TestIamPermissionsCall) Do ¶
func (c *V1TestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error)
Do executes the "iap.testIamPermissions" call. Exactly one of *TestIamPermissionsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*V1TestIamPermissionsCall) Fields ¶
func (c *V1TestIamPermissionsCall) Fields(s ...googleapi.Field) *V1TestIamPermissionsCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*V1TestIamPermissionsCall) Header ¶
func (c *V1TestIamPermissionsCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type V1UpdateIapSettingsCall ¶
type V1UpdateIapSettingsCall struct {
// contains filtered or unexported fields
}
func (*V1UpdateIapSettingsCall) Context ¶
func (c *V1UpdateIapSettingsCall) Context(ctx context.Context) *V1UpdateIapSettingsCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*V1UpdateIapSettingsCall) Do ¶
func (c *V1UpdateIapSettingsCall) Do(opts ...googleapi.CallOption) (*IapSettings, error)
Do executes the "iap.updateIapSettings" call. Exactly one of *IapSettings or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *IapSettings.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*V1UpdateIapSettingsCall) Fields ¶
func (c *V1UpdateIapSettingsCall) Fields(s ...googleapi.Field) *V1UpdateIapSettingsCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*V1UpdateIapSettingsCall) Header ¶
func (c *V1UpdateIapSettingsCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*V1UpdateIapSettingsCall) UpdateMask ¶
func (c *V1UpdateIapSettingsCall) UpdateMask(updateMask string) *V1UpdateIapSettingsCall
UpdateMask sets the optional parameter "updateMask": The field mask specifying which IAP settings should be updated. If omitted, the all of the settings are updated. See https://developers.google.com/protocol-buffers/docs/reference/goog le.protobuf#fieldmask