Documentation ¶
Overview ¶
Package cloudidentity provides access to the Cloud Identity API.
For product documentation, see: https://cloud.google.com/identity/
Creating a client ¶
Usage example:
import "google.golang.org/api/cloudidentity/v1beta1" ... ctx := context.Background() cloudidentityService, err := cloudidentity.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 ¶
By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use option.WithScopes:
cloudidentityService, err := cloudidentity.NewService(ctx, option.WithScopes(cloudidentity.CloudPlatformScope))
To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:
cloudidentityService, err := cloudidentity.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, ...) cloudidentityService, err := cloudidentity.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
See https://godoc.org/google.golang.org/api/option/ for details on options.
Index ¶
- Constants
- type EntityKey
- type GetMembershipGraphResponse
- type Group
- type GroupsCreateCall
- func (c *GroupsCreateCall) Context(ctx context.Context) *GroupsCreateCall
- func (c *GroupsCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *GroupsCreateCall) Fields(s ...googleapi.Field) *GroupsCreateCall
- func (c *GroupsCreateCall) Header() http.Header
- func (c *GroupsCreateCall) InitialGroupConfig(initialGroupConfig string) *GroupsCreateCall
- type GroupsDeleteCall
- type GroupsGetCall
- func (c *GroupsGetCall) Context(ctx context.Context) *GroupsGetCall
- func (c *GroupsGetCall) Do(opts ...googleapi.CallOption) (*Group, error)
- func (c *GroupsGetCall) Fields(s ...googleapi.Field) *GroupsGetCall
- func (c *GroupsGetCall) Header() http.Header
- func (c *GroupsGetCall) IfNoneMatch(entityTag string) *GroupsGetCall
- type GroupsListCall
- func (c *GroupsListCall) Context(ctx context.Context) *GroupsListCall
- func (c *GroupsListCall) Do(opts ...googleapi.CallOption) (*ListGroupsResponse, error)
- func (c *GroupsListCall) Fields(s ...googleapi.Field) *GroupsListCall
- func (c *GroupsListCall) Header() http.Header
- func (c *GroupsListCall) IfNoneMatch(entityTag string) *GroupsListCall
- func (c *GroupsListCall) PageSize(pageSize int64) *GroupsListCall
- func (c *GroupsListCall) PageToken(pageToken string) *GroupsListCall
- func (c *GroupsListCall) Pages(ctx context.Context, f func(*ListGroupsResponse) error) error
- func (c *GroupsListCall) Parent(parent string) *GroupsListCall
- func (c *GroupsListCall) View(view string) *GroupsListCall
- type GroupsLookupCall
- func (c *GroupsLookupCall) Context(ctx context.Context) *GroupsLookupCall
- func (c *GroupsLookupCall) Do(opts ...googleapi.CallOption) (*LookupGroupNameResponse, error)
- func (c *GroupsLookupCall) Fields(s ...googleapi.Field) *GroupsLookupCall
- func (c *GroupsLookupCall) GroupKeyId(groupKeyId string) *GroupsLookupCall
- func (c *GroupsLookupCall) GroupKeyNamespace(groupKeyNamespace string) *GroupsLookupCall
- func (c *GroupsLookupCall) Header() http.Header
- func (c *GroupsLookupCall) IfNoneMatch(entityTag string) *GroupsLookupCall
- type GroupsMembershipsCreateCall
- func (c *GroupsMembershipsCreateCall) Context(ctx context.Context) *GroupsMembershipsCreateCall
- func (c *GroupsMembershipsCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *GroupsMembershipsCreateCall) Fields(s ...googleapi.Field) *GroupsMembershipsCreateCall
- func (c *GroupsMembershipsCreateCall) Header() http.Header
- type GroupsMembershipsDeleteCall
- func (c *GroupsMembershipsDeleteCall) Context(ctx context.Context) *GroupsMembershipsDeleteCall
- func (c *GroupsMembershipsDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *GroupsMembershipsDeleteCall) Fields(s ...googleapi.Field) *GroupsMembershipsDeleteCall
- func (c *GroupsMembershipsDeleteCall) Header() http.Header
- type GroupsMembershipsGetCall
- func (c *GroupsMembershipsGetCall) Context(ctx context.Context) *GroupsMembershipsGetCall
- func (c *GroupsMembershipsGetCall) Do(opts ...googleapi.CallOption) (*Membership, error)
- func (c *GroupsMembershipsGetCall) Fields(s ...googleapi.Field) *GroupsMembershipsGetCall
- func (c *GroupsMembershipsGetCall) Header() http.Header
- func (c *GroupsMembershipsGetCall) IfNoneMatch(entityTag string) *GroupsMembershipsGetCall
- type GroupsMembershipsListCall
- func (c *GroupsMembershipsListCall) Context(ctx context.Context) *GroupsMembershipsListCall
- func (c *GroupsMembershipsListCall) Do(opts ...googleapi.CallOption) (*ListMembershipsResponse, error)
- func (c *GroupsMembershipsListCall) Fields(s ...googleapi.Field) *GroupsMembershipsListCall
- func (c *GroupsMembershipsListCall) Header() http.Header
- func (c *GroupsMembershipsListCall) IfNoneMatch(entityTag string) *GroupsMembershipsListCall
- func (c *GroupsMembershipsListCall) PageSize(pageSize int64) *GroupsMembershipsListCall
- func (c *GroupsMembershipsListCall) PageToken(pageToken string) *GroupsMembershipsListCall
- func (c *GroupsMembershipsListCall) Pages(ctx context.Context, f func(*ListMembershipsResponse) error) error
- func (c *GroupsMembershipsListCall) View(view string) *GroupsMembershipsListCall
- type GroupsMembershipsLookupCall
- func (c *GroupsMembershipsLookupCall) Context(ctx context.Context) *GroupsMembershipsLookupCall
- func (c *GroupsMembershipsLookupCall) Do(opts ...googleapi.CallOption) (*LookupMembershipNameResponse, error)
- func (c *GroupsMembershipsLookupCall) Fields(s ...googleapi.Field) *GroupsMembershipsLookupCall
- func (c *GroupsMembershipsLookupCall) Header() http.Header
- func (c *GroupsMembershipsLookupCall) IfNoneMatch(entityTag string) *GroupsMembershipsLookupCall
- func (c *GroupsMembershipsLookupCall) MemberKeyId(memberKeyId string) *GroupsMembershipsLookupCall
- func (c *GroupsMembershipsLookupCall) MemberKeyNamespace(memberKeyNamespace string) *GroupsMembershipsLookupCall
- type GroupsMembershipsModifyMembershipRolesCall
- func (c *GroupsMembershipsModifyMembershipRolesCall) Context(ctx context.Context) *GroupsMembershipsModifyMembershipRolesCall
- func (c *GroupsMembershipsModifyMembershipRolesCall) Do(opts ...googleapi.CallOption) (*ModifyMembershipRolesResponse, error)
- func (c *GroupsMembershipsModifyMembershipRolesCall) Fields(s ...googleapi.Field) *GroupsMembershipsModifyMembershipRolesCall
- func (c *GroupsMembershipsModifyMembershipRolesCall) Header() http.Header
- type GroupsMembershipsService
- func (r *GroupsMembershipsService) Create(parent string, membership *Membership) *GroupsMembershipsCreateCall
- func (r *GroupsMembershipsService) Delete(name string) *GroupsMembershipsDeleteCall
- func (r *GroupsMembershipsService) Get(name string) *GroupsMembershipsGetCall
- func (r *GroupsMembershipsService) List(parent string) *GroupsMembershipsListCall
- func (r *GroupsMembershipsService) Lookup(parent string) *GroupsMembershipsLookupCall
- func (r *GroupsMembershipsService) ModifyMembershipRoles(name string, modifymembershiprolesrequest *ModifyMembershipRolesRequest) *GroupsMembershipsModifyMembershipRolesCall
- type GroupsPatchCall
- func (c *GroupsPatchCall) Context(ctx context.Context) *GroupsPatchCall
- func (c *GroupsPatchCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *GroupsPatchCall) Fields(s ...googleapi.Field) *GroupsPatchCall
- func (c *GroupsPatchCall) Header() http.Header
- func (c *GroupsPatchCall) UpdateMask(updateMask string) *GroupsPatchCall
- type GroupsSearchCall
- func (c *GroupsSearchCall) Context(ctx context.Context) *GroupsSearchCall
- func (c *GroupsSearchCall) Do(opts ...googleapi.CallOption) (*SearchGroupsResponse, error)
- func (c *GroupsSearchCall) Fields(s ...googleapi.Field) *GroupsSearchCall
- func (c *GroupsSearchCall) Header() http.Header
- func (c *GroupsSearchCall) IfNoneMatch(entityTag string) *GroupsSearchCall
- func (c *GroupsSearchCall) PageSize(pageSize int64) *GroupsSearchCall
- func (c *GroupsSearchCall) PageToken(pageToken string) *GroupsSearchCall
- func (c *GroupsSearchCall) Pages(ctx context.Context, f func(*SearchGroupsResponse) error) error
- func (c *GroupsSearchCall) Query(query string) *GroupsSearchCall
- func (c *GroupsSearchCall) View(view string) *GroupsSearchCall
- type GroupsService
- func (r *GroupsService) Create(group *Group) *GroupsCreateCall
- func (r *GroupsService) Delete(name string) *GroupsDeleteCall
- func (r *GroupsService) Get(name string) *GroupsGetCall
- func (r *GroupsService) List() *GroupsListCall
- func (r *GroupsService) Lookup() *GroupsLookupCall
- func (r *GroupsService) Patch(name string, group *Group) *GroupsPatchCall
- func (r *GroupsService) Search() *GroupsSearchCall
- type ListGroupsResponse
- type ListMembershipsResponse
- type LookupGroupNameResponse
- type LookupMembershipNameResponse
- type Membership
- type MembershipAdjacencyList
- type MembershipRole
- type ModifyMembershipRolesRequest
- type ModifyMembershipRolesResponse
- type Operation
- type SearchGroupsResponse
- type Service
- type Status
- type UpdateMembershipRolesParams
Constants ¶
const ( // See, change, create, and delete any of the Cloud Identity Groups that // you can access, including the members of each group CloudIdentityGroupsScope = "https://www.googleapis.com/auth/cloud-identity.groups" // See any Cloud Identity Groups that you can access, including group // members and their emails CloudIdentityGroupsReadonlyScope = "https://www.googleapis.com/auth/cloud-identity.groups.readonly" // 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 EntityKey ¶
type EntityKey struct { // Id: The ID of the entity. // // For Google-managed entities, the `id` must be the email address of // an // existing group or user. // // For external-identity-mapped entities, the `id` must be a string // conforming // to the Identity Source's requirements. // // Must be unique within a `namespace`. Id string `json:"id,omitempty"` // Namespace: The namespace in which the entity exists. // // If not specified, the `EntityKey` represents a Google-managed entity // such // as a Google user or a Google Group. // // If specified, the `EntityKey` represents an external-identity-mapped // group. // The namespace must correspond to an identity source created in // Admin // Console. Must be of the form `identitysources/{identity_source_id}. Namespace string `json:"namespace,omitempty"` // ForceSendFields is a list of field names (e.g. "Id") 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. "Id") 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:"-"` }
EntityKey: A unique identifier for an entity in the Cloud Identity Groups API.
An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s.
func (*EntityKey) MarshalJSON ¶
type GetMembershipGraphResponse ¶
type GetMembershipGraphResponse struct { // AdjacencyList: The membership graph's path information represented as // an adjacency list. AdjacencyList []*MembershipAdjacencyList `json:"adjacencyList,omitempty"` // Groups: The resources representing each group in the adjacency list. // Each // group in this list can be correlated to a 'group' of // the // MembershipAdjacencyList using the 'name' of the Group resource. Groups []*Group `json:"groups,omitempty"` // ForceSendFields is a list of field names (e.g. "AdjacencyList") 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. "AdjacencyList") 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:"-"` }
GetMembershipGraphResponse: The response message for MembershipsService.GetMembershipGraph.
func (*GetMembershipGraphResponse) MarshalJSON ¶
func (s *GetMembershipGraphResponse) MarshalJSON() ([]byte, error)
type Group ¶
type Group struct { // AdditionalGroupKeys: Additional entity key aliases for a Group. AdditionalGroupKeys []*EntityKey `json:"additionalGroupKeys,omitempty"` // CreateTime: Output only. The time when the `Group` was created. CreateTime string `json:"createTime,omitempty"` // Description: An extended description to help users determine the // purpose of a `Group`. // // Must not be longer than 4,096 characters. Description string `json:"description,omitempty"` // DisplayName: The display name of the `Group`. DisplayName string `json:"displayName,omitempty"` // GroupKey: Required. Immutable. The `EntityKey` of the `Group`. GroupKey *EntityKey `json:"groupKey,omitempty"` // Labels: Required. The labels that apply to the `Group`. // // Must not contain more than one entry. Must contain the // entry // `'cloudidentity.googleapis.com/groups.discussion_forum': ”` if the // `Group` // is a Google Group or `'system/groups/external': ”` if the `Group` is // an // external-identity-mapped group. Labels map[string]string `json:"labels,omitempty"` // Name: Output only. The [resource // name](https://cloud.google.com/apis/design/resource_names) of // the `Group`. // // Shall be of the form `groups/{group_id}`. Name string `json:"name,omitempty"` // Parent: Required. Immutable. The resource name of the entity under // which this `Group` resides in the // Cloud Identity resource hierarchy. // // Must be of the form `identitysources/{identity_source_id}` for // external- // identity-mapped groups or `customers/{customer_id}` for Google // Groups. Parent string `json:"parent,omitempty"` // UpdateTime: Output only. The time when the `Group` was last updated. UpdateTime string `json:"updateTime,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "AdditionalGroupKeys") // 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. "AdditionalGroupKeys") 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:"-"` }
Group: A group within the Cloud Identity Groups API.
A `Group` is a collection of entities, where each entity is either a user or another group or a service account.
func (*Group) MarshalJSON ¶
type GroupsCreateCall ¶
type GroupsCreateCall struct {
// contains filtered or unexported fields
}
func (*GroupsCreateCall) Context ¶
func (c *GroupsCreateCall) Context(ctx context.Context) *GroupsCreateCall
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 (*GroupsCreateCall) Do ¶
func (c *GroupsCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "cloudidentity.groups.create" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.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 (*GroupsCreateCall) Fields ¶
func (c *GroupsCreateCall) Fields(s ...googleapi.Field) *GroupsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*GroupsCreateCall) Header ¶
func (c *GroupsCreateCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*GroupsCreateCall) InitialGroupConfig ¶
func (c *GroupsCreateCall) InitialGroupConfig(initialGroupConfig string) *GroupsCreateCall
InitialGroupConfig sets the optional parameter "initialGroupConfig": Required. The initial configuration option for the `Group`.
Possible values:
"INITIAL_GROUP_CONFIG_UNSPECIFIED" "WITH_INITIAL_OWNER" "EMPTY"
type GroupsDeleteCall ¶
type GroupsDeleteCall struct {
// contains filtered or unexported fields
}
func (*GroupsDeleteCall) Context ¶
func (c *GroupsDeleteCall) Context(ctx context.Context) *GroupsDeleteCall
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 (*GroupsDeleteCall) Do ¶
func (c *GroupsDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "cloudidentity.groups.delete" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.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 (*GroupsDeleteCall) Fields ¶
func (c *GroupsDeleteCall) Fields(s ...googleapi.Field) *GroupsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*GroupsDeleteCall) Header ¶
func (c *GroupsDeleteCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type GroupsGetCall ¶
type GroupsGetCall struct {
// contains filtered or unexported fields
}
func (*GroupsGetCall) Context ¶
func (c *GroupsGetCall) Context(ctx context.Context) *GroupsGetCall
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 (*GroupsGetCall) Do ¶
func (c *GroupsGetCall) Do(opts ...googleapi.CallOption) (*Group, error)
Do executes the "cloudidentity.groups.get" call. Exactly one of *Group or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Group.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 (*GroupsGetCall) Fields ¶
func (c *GroupsGetCall) Fields(s ...googleapi.Field) *GroupsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*GroupsGetCall) Header ¶
func (c *GroupsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*GroupsGetCall) IfNoneMatch ¶
func (c *GroupsGetCall) IfNoneMatch(entityTag string) *GroupsGetCall
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 GroupsListCall ¶
type GroupsListCall struct {
// contains filtered or unexported fields
}
func (*GroupsListCall) Context ¶
func (c *GroupsListCall) Context(ctx context.Context) *GroupsListCall
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 (*GroupsListCall) Do ¶
func (c *GroupsListCall) Do(opts ...googleapi.CallOption) (*ListGroupsResponse, error)
Do executes the "cloudidentity.groups.list" call. Exactly one of *ListGroupsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListGroupsResponse.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 (*GroupsListCall) Fields ¶
func (c *GroupsListCall) Fields(s ...googleapi.Field) *GroupsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*GroupsListCall) Header ¶
func (c *GroupsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*GroupsListCall) IfNoneMatch ¶
func (c *GroupsListCall) IfNoneMatch(entityTag string) *GroupsListCall
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 (*GroupsListCall) PageSize ¶
func (c *GroupsListCall) PageSize(pageSize int64) *GroupsListCall
PageSize sets the optional parameter "pageSize": The maximum number of results to return.
Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains a `next_page_token`.
If unspecified, defaults to 200 for `View.BASIC` and to 50 for `View.FULL`.
Must not be greater than 1000 for `View.BASIC` or 500 for `View.FULL`.
func (*GroupsListCall) PageToken ¶
func (c *GroupsListCall) PageToken(pageToken string) *GroupsListCall
PageToken sets the optional parameter "pageToken": The `next_page_token` value returned from a previous list request, if any.
func (*GroupsListCall) Pages ¶
func (c *GroupsListCall) Pages(ctx context.Context, f func(*ListGroupsResponse) 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.
func (*GroupsListCall) Parent ¶
func (c *GroupsListCall) Parent(parent string) *GroupsListCall
Parent sets the optional parameter "parent": Required. The parent resource under which to list all `Group`s.
Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups.
func (*GroupsListCall) View ¶
func (c *GroupsListCall) View(view string) *GroupsListCall
View sets the optional parameter "view": The level of detail to be returned.
If unspecified, defaults to `View.BASIC`.
Possible values:
"VIEW_UNSPECIFIED" "BASIC" "FULL"
type GroupsLookupCall ¶
type GroupsLookupCall struct {
// contains filtered or unexported fields
}
func (*GroupsLookupCall) Context ¶
func (c *GroupsLookupCall) Context(ctx context.Context) *GroupsLookupCall
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 (*GroupsLookupCall) Do ¶
func (c *GroupsLookupCall) Do(opts ...googleapi.CallOption) (*LookupGroupNameResponse, error)
Do executes the "cloudidentity.groups.lookup" call. Exactly one of *LookupGroupNameResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *LookupGroupNameResponse.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 (*GroupsLookupCall) Fields ¶
func (c *GroupsLookupCall) Fields(s ...googleapi.Field) *GroupsLookupCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*GroupsLookupCall) GroupKeyId ¶
func (c *GroupsLookupCall) GroupKeyId(groupKeyId string) *GroupsLookupCall
GroupKeyId sets the optional parameter "groupKey.id": The ID of the entity.
For Google-managed entities, the `id` must be the email address of an existing group or user.
For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements.
Must be unique within a `namespace`.
func (*GroupsLookupCall) GroupKeyNamespace ¶
func (c *GroupsLookupCall) GroupKeyNamespace(groupKeyNamespace string) *GroupsLookupCall
GroupKeyNamespace sets the optional parameter "groupKey.namespace": The namespace in which the entity exists.
If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group.
If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console. Must be of the form `identitysources/{identity_source_id}.
func (*GroupsLookupCall) Header ¶
func (c *GroupsLookupCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*GroupsLookupCall) IfNoneMatch ¶
func (c *GroupsLookupCall) IfNoneMatch(entityTag string) *GroupsLookupCall
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 GroupsMembershipsCreateCall ¶
type GroupsMembershipsCreateCall struct {
// contains filtered or unexported fields
}
func (*GroupsMembershipsCreateCall) Context ¶
func (c *GroupsMembershipsCreateCall) Context(ctx context.Context) *GroupsMembershipsCreateCall
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 (*GroupsMembershipsCreateCall) Do ¶
func (c *GroupsMembershipsCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "cloudidentity.groups.memberships.create" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.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 (*GroupsMembershipsCreateCall) Fields ¶
func (c *GroupsMembershipsCreateCall) Fields(s ...googleapi.Field) *GroupsMembershipsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*GroupsMembershipsCreateCall) Header ¶
func (c *GroupsMembershipsCreateCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type GroupsMembershipsDeleteCall ¶
type GroupsMembershipsDeleteCall struct {
// contains filtered or unexported fields
}
func (*GroupsMembershipsDeleteCall) Context ¶
func (c *GroupsMembershipsDeleteCall) Context(ctx context.Context) *GroupsMembershipsDeleteCall
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 (*GroupsMembershipsDeleteCall) Do ¶
func (c *GroupsMembershipsDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "cloudidentity.groups.memberships.delete" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.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 (*GroupsMembershipsDeleteCall) Fields ¶
func (c *GroupsMembershipsDeleteCall) Fields(s ...googleapi.Field) *GroupsMembershipsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*GroupsMembershipsDeleteCall) Header ¶
func (c *GroupsMembershipsDeleteCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type GroupsMembershipsGetCall ¶
type GroupsMembershipsGetCall struct {
// contains filtered or unexported fields
}
func (*GroupsMembershipsGetCall) Context ¶
func (c *GroupsMembershipsGetCall) Context(ctx context.Context) *GroupsMembershipsGetCall
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 (*GroupsMembershipsGetCall) Do ¶
func (c *GroupsMembershipsGetCall) Do(opts ...googleapi.CallOption) (*Membership, error)
Do executes the "cloudidentity.groups.memberships.get" call. Exactly one of *Membership or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Membership.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 (*GroupsMembershipsGetCall) Fields ¶
func (c *GroupsMembershipsGetCall) Fields(s ...googleapi.Field) *GroupsMembershipsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*GroupsMembershipsGetCall) Header ¶
func (c *GroupsMembershipsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*GroupsMembershipsGetCall) IfNoneMatch ¶
func (c *GroupsMembershipsGetCall) IfNoneMatch(entityTag string) *GroupsMembershipsGetCall
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 GroupsMembershipsListCall ¶
type GroupsMembershipsListCall struct {
// contains filtered or unexported fields
}
func (*GroupsMembershipsListCall) Context ¶
func (c *GroupsMembershipsListCall) Context(ctx context.Context) *GroupsMembershipsListCall
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 (*GroupsMembershipsListCall) Do ¶
func (c *GroupsMembershipsListCall) Do(opts ...googleapi.CallOption) (*ListMembershipsResponse, error)
Do executes the "cloudidentity.groups.memberships.list" call. Exactly one of *ListMembershipsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListMembershipsResponse.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 (*GroupsMembershipsListCall) Fields ¶
func (c *GroupsMembershipsListCall) Fields(s ...googleapi.Field) *GroupsMembershipsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*GroupsMembershipsListCall) Header ¶
func (c *GroupsMembershipsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*GroupsMembershipsListCall) IfNoneMatch ¶
func (c *GroupsMembershipsListCall) IfNoneMatch(entityTag string) *GroupsMembershipsListCall
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 (*GroupsMembershipsListCall) PageSize ¶
func (c *GroupsMembershipsListCall) PageSize(pageSize int64) *GroupsMembershipsListCall
PageSize sets the optional parameter "pageSize": The maximum number of results to return.
Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains a `next_page_token`.
If unspecified, defaults to 200 for `GroupView.BASIC` and to 50 for `GroupView.FULL`.
Must not be greater than 1000 for `GroupView.BASIC` or 500 for `GroupView.FULL`.
func (*GroupsMembershipsListCall) PageToken ¶
func (c *GroupsMembershipsListCall) PageToken(pageToken string) *GroupsMembershipsListCall
PageToken sets the optional parameter "pageToken": The `next_page_token` value returned from a previous search request, if any.
func (*GroupsMembershipsListCall) Pages ¶
func (c *GroupsMembershipsListCall) Pages(ctx context.Context, f func(*ListMembershipsResponse) 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.
func (*GroupsMembershipsListCall) View ¶
func (c *GroupsMembershipsListCall) View(view string) *GroupsMembershipsListCall
View sets the optional parameter "view": The level of detail to be returned.
If unspecified, defaults to `MembershipView.BASIC`.
Possible values:
"BASIC" "FULL"
type GroupsMembershipsLookupCall ¶
type GroupsMembershipsLookupCall struct {
// contains filtered or unexported fields
}
func (*GroupsMembershipsLookupCall) Context ¶
func (c *GroupsMembershipsLookupCall) Context(ctx context.Context) *GroupsMembershipsLookupCall
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 (*GroupsMembershipsLookupCall) Do ¶
func (c *GroupsMembershipsLookupCall) Do(opts ...googleapi.CallOption) (*LookupMembershipNameResponse, error)
Do executes the "cloudidentity.groups.memberships.lookup" call. Exactly one of *LookupMembershipNameResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *LookupMembershipNameResponse.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 (*GroupsMembershipsLookupCall) Fields ¶
func (c *GroupsMembershipsLookupCall) Fields(s ...googleapi.Field) *GroupsMembershipsLookupCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*GroupsMembershipsLookupCall) Header ¶
func (c *GroupsMembershipsLookupCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*GroupsMembershipsLookupCall) IfNoneMatch ¶
func (c *GroupsMembershipsLookupCall) IfNoneMatch(entityTag string) *GroupsMembershipsLookupCall
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 (*GroupsMembershipsLookupCall) MemberKeyId ¶
func (c *GroupsMembershipsLookupCall) MemberKeyId(memberKeyId string) *GroupsMembershipsLookupCall
MemberKeyId sets the optional parameter "memberKey.id": The ID of the entity.
For Google-managed entities, the `id` must be the email address of an existing group or user.
For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements.
Must be unique within a `namespace`.
func (*GroupsMembershipsLookupCall) MemberKeyNamespace ¶
func (c *GroupsMembershipsLookupCall) MemberKeyNamespace(memberKeyNamespace string) *GroupsMembershipsLookupCall
MemberKeyNamespace sets the optional parameter "memberKey.namespace": The namespace in which the entity exists.
If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group.
If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console. Must be of the form `identitysources/{identity_source_id}.
type GroupsMembershipsModifyMembershipRolesCall ¶
type GroupsMembershipsModifyMembershipRolesCall struct {
// contains filtered or unexported fields
}
func (*GroupsMembershipsModifyMembershipRolesCall) Context ¶
func (c *GroupsMembershipsModifyMembershipRolesCall) Context(ctx context.Context) *GroupsMembershipsModifyMembershipRolesCall
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 (*GroupsMembershipsModifyMembershipRolesCall) Do ¶
func (c *GroupsMembershipsModifyMembershipRolesCall) Do(opts ...googleapi.CallOption) (*ModifyMembershipRolesResponse, error)
Do executes the "cloudidentity.groups.memberships.modifyMembershipRoles" call. Exactly one of *ModifyMembershipRolesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ModifyMembershipRolesResponse.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 (*GroupsMembershipsModifyMembershipRolesCall) Fields ¶
func (c *GroupsMembershipsModifyMembershipRolesCall) Fields(s ...googleapi.Field) *GroupsMembershipsModifyMembershipRolesCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*GroupsMembershipsModifyMembershipRolesCall) Header ¶
func (c *GroupsMembershipsModifyMembershipRolesCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type GroupsMembershipsService ¶
type GroupsMembershipsService struct {
// contains filtered or unexported fields
}
func NewGroupsMembershipsService ¶
func NewGroupsMembershipsService(s *Service) *GroupsMembershipsService
func (*GroupsMembershipsService) Create ¶
func (r *GroupsMembershipsService) Create(parent string, membership *Membership) *GroupsMembershipsCreateCall
Create: Creates a `Membership`.
func (*GroupsMembershipsService) Delete ¶
func (r *GroupsMembershipsService) Delete(name string) *GroupsMembershipsDeleteCall
Delete: Deletes a `Membership`.
func (*GroupsMembershipsService) Get ¶
func (r *GroupsMembershipsService) Get(name string) *GroupsMembershipsGetCall
Get: Retrieves a `Membership`.
func (*GroupsMembershipsService) List ¶
func (r *GroupsMembershipsService) List(parent string) *GroupsMembershipsListCall
List: Lists the `Membership`s within a `Group`.
func (*GroupsMembershipsService) Lookup ¶
func (r *GroupsMembershipsService) Lookup(parent string) *GroupsMembershipsLookupCall
Lookup: Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Membership` by its `EntityKey`.
func (*GroupsMembershipsService) ModifyMembershipRoles ¶
func (r *GroupsMembershipsService) ModifyMembershipRoles(name string, modifymembershiprolesrequest *ModifyMembershipRolesRequest) *GroupsMembershipsModifyMembershipRolesCall
ModifyMembershipRoles: Modifies the `MembershipRole`s of a `Membership`.
type GroupsPatchCall ¶
type GroupsPatchCall struct {
// contains filtered or unexported fields
}
func (*GroupsPatchCall) Context ¶
func (c *GroupsPatchCall) Context(ctx context.Context) *GroupsPatchCall
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 (*GroupsPatchCall) Do ¶
func (c *GroupsPatchCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "cloudidentity.groups.patch" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.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 (*GroupsPatchCall) Fields ¶
func (c *GroupsPatchCall) Fields(s ...googleapi.Field) *GroupsPatchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*GroupsPatchCall) Header ¶
func (c *GroupsPatchCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*GroupsPatchCall) UpdateMask ¶
func (c *GroupsPatchCall) UpdateMask(updateMask string) *GroupsPatchCall
UpdateMask sets the optional parameter "updateMask": Required. The fully-qualified names of fields to update.
May only contain the following fields: `display_name`, `description`.
type GroupsSearchCall ¶
type GroupsSearchCall struct {
// contains filtered or unexported fields
}
func (*GroupsSearchCall) Context ¶
func (c *GroupsSearchCall) Context(ctx context.Context) *GroupsSearchCall
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 (*GroupsSearchCall) Do ¶
func (c *GroupsSearchCall) Do(opts ...googleapi.CallOption) (*SearchGroupsResponse, error)
Do executes the "cloudidentity.groups.search" call. Exactly one of *SearchGroupsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *SearchGroupsResponse.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 (*GroupsSearchCall) Fields ¶
func (c *GroupsSearchCall) Fields(s ...googleapi.Field) *GroupsSearchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*GroupsSearchCall) Header ¶
func (c *GroupsSearchCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*GroupsSearchCall) IfNoneMatch ¶
func (c *GroupsSearchCall) IfNoneMatch(entityTag string) *GroupsSearchCall
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 (*GroupsSearchCall) PageSize ¶
func (c *GroupsSearchCall) PageSize(pageSize int64) *GroupsSearchCall
PageSize sets the optional parameter "pageSize": The maximum number of results to return.
Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains a `next_page_token`.
If unspecified, defaults to 200 for `GroupView.BASIC` and to 50 for `GroupView.FULL`.
Must not be greater than 1000 for `GroupView.BASIC` or 500 for `GroupView.FULL`.
func (*GroupsSearchCall) PageToken ¶
func (c *GroupsSearchCall) PageToken(pageToken string) *GroupsSearchCall
PageToken sets the optional parameter "pageToken": The `next_page_token` value returned from a previous search request, if any.
func (*GroupsSearchCall) Pages ¶
func (c *GroupsSearchCall) Pages(ctx context.Context, f func(*SearchGroupsResponse) 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.
func (*GroupsSearchCall) Query ¶
func (c *GroupsSearchCall) Query(query string) *GroupsSearchCall
Query sets the optional parameter "query": Required. The search query.
Must be specified in [Common Expression Language](https://opensource.google/projects/cel). May only contain equality operators on the parent and inclusion operators on labels (e.g., `parent == 'customers/{customer_id}' && 'cloudidentity.googleapis.com/groups.discussion_forum' in labels`).
func (*GroupsSearchCall) View ¶
func (c *GroupsSearchCall) View(view string) *GroupsSearchCall
View sets the optional parameter "view": The level of detail to be returned.
If unspecified, defaults to `View.BASIC`.
Possible values:
"BASIC" "FULL"
type GroupsService ¶
type GroupsService struct { Memberships *GroupsMembershipsService // contains filtered or unexported fields }
func NewGroupsService ¶
func NewGroupsService(s *Service) *GroupsService
func (*GroupsService) Create ¶
func (r *GroupsService) Create(group *Group) *GroupsCreateCall
Create: Creates a `Group`.
func (*GroupsService) Delete ¶
func (r *GroupsService) Delete(name string) *GroupsDeleteCall
Delete: Deletes a `Group`.
func (*GroupsService) Get ¶
func (r *GroupsService) Get(name string) *GroupsGetCall
Get: Retrieves a `Group`.
func (*GroupsService) List ¶
func (r *GroupsService) List() *GroupsListCall
List: Lists the `Group`s under a customer or namespace.
func (*GroupsService) Lookup ¶
func (r *GroupsService) Lookup() *GroupsLookupCall
Lookup: Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Group` by its `EntityKey`.
func (*GroupsService) Patch ¶
func (r *GroupsService) Patch(name string, group *Group) *GroupsPatchCall
Patch: Updates a `Group`.
func (*GroupsService) Search ¶
func (r *GroupsService) Search() *GroupsSearchCall
Search: Searches for `Group`s matching a specified query.
type ListGroupsResponse ¶
type ListGroupsResponse struct { // Groups: The `Group`s under the specified `parent`. Groups []*Group `json:"groups,omitempty"` // NextPageToken: A continuation token to retrieve the next page of // results, or empty if // there are no more results available. 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. "Groups") 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. "Groups") 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:"-"` }
ListGroupsResponse: The response message for GroupsService.ListGroups.
func (*ListGroupsResponse) MarshalJSON ¶
func (s *ListGroupsResponse) MarshalJSON() ([]byte, error)
type ListMembershipsResponse ¶
type ListMembershipsResponse struct { // Memberships: The `Membership`s under the specified `parent`. Memberships []*Membership `json:"memberships,omitempty"` // NextPageToken: A continuation token to retrieve the next page of // results, or empty if // there are no more results available. 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. "Memberships") 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. "Memberships") 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:"-"` }
ListMembershipsResponse: The response message for MembershipsService.ListMemberships.
func (*ListMembershipsResponse) MarshalJSON ¶
func (s *ListMembershipsResponse) MarshalJSON() ([]byte, error)
type LookupGroupNameResponse ¶
type LookupGroupNameResponse struct { // Name: Output only. The [resource // name](https://cloud.google.com/apis/design/resource_names) of // the looked-up `Group`. 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. "Name") 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. "Name") 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:"-"` }
LookupGroupNameResponse: The response message for GroupsService.LookupGroupName.
func (*LookupGroupNameResponse) MarshalJSON ¶
func (s *LookupGroupNameResponse) MarshalJSON() ([]byte, error)
type LookupMembershipNameResponse ¶
type LookupMembershipNameResponse struct { // Name: The [resource // name](https://cloud.google.com/apis/design/resource_names) of // the looked-up `Membership`. // // Must be of the form `groups/{group_id}/memberships/{membership_id}`. 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. "Name") 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. "Name") 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:"-"` }
LookupMembershipNameResponse: The response message for MembershipsService.LookupMembershipName.
func (*LookupMembershipNameResponse) MarshalJSON ¶
func (s *LookupMembershipNameResponse) MarshalJSON() ([]byte, error)
type Membership ¶
type Membership struct { // CreateTime: Output only. The time when the `Membership` was created. CreateTime string `json:"createTime,omitempty"` // MemberKey: Immutable. The `EntityKey` of the member. // // Either `member_key` or `preferred_member_key` must be set when // calling // MembershipsService.CreateMembership but not both; both shall be // set // when returned. MemberKey *EntityKey `json:"memberKey,omitempty"` // Name: Output only. The [resource // name](https://cloud.google.com/apis/design/resource_names) of // the `Membership`. // // Shall be of the form `groups/{group_id}/memberships/{membership_id}`. Name string `json:"name,omitempty"` // PreferredMemberKey: Required. Immutable. The `EntityKey` of the // member. // // Either `member_key` or `preferred_member_key` must be set when // calling // MembershipsService.CreateMembership but not both; both shall be // set // when returned. PreferredMemberKey *EntityKey `json:"preferredMemberKey,omitempty"` // Roles: The `MembershipRole`s that apply to the `Membership`. // // If unspecified, defaults to a single `MembershipRole` with `name` // `MEMBER`. // // Must not contain duplicate `MembershipRole`s with the same `name`. Roles []*MembershipRole `json:"roles,omitempty"` // UpdateTime: Output only. The time when the `Membership` was last // updated. UpdateTime string `json:"updateTime,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "CreateTime") 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. "CreateTime") 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:"-"` }
Membership: A membership within the Cloud Identity Groups API.
A `Membership` defines a relationship between a `Group` and an entity belonging to that `Group`, referred to as a "member".
func (*Membership) MarshalJSON ¶
func (s *Membership) MarshalJSON() ([]byte, error)
type MembershipAdjacencyList ¶
type MembershipAdjacencyList struct { // Edges: Each edge contains information about the member that belongs // to this group. Edges []*Membership `json:"edges,omitempty"` // Group: Resource name of the group that the members belong to. Group string `json:"group,omitempty"` // ForceSendFields is a list of field names (e.g. "Edges") 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. "Edges") 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:"-"` }
MembershipAdjacencyList: Membership graph's path information as an adjacency list.
func (*MembershipAdjacencyList) MarshalJSON ¶
func (s *MembershipAdjacencyList) MarshalJSON() ([]byte, error)
type MembershipRole ¶
type MembershipRole struct { // Name: The name of the `MembershipRole`. // // Must be one of `OWNER`, `MANAGER`, `MEMBER`. Name string `json:"name,omitempty"` // ForceSendFields is a list of field names (e.g. "Name") 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. "Name") 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:"-"` }
MembershipRole: A membership role within the Cloud Identity Groups API.
A `MembershipRole` defines the privileges granted to a `Membership`.
func (*MembershipRole) MarshalJSON ¶
func (s *MembershipRole) MarshalJSON() ([]byte, error)
type ModifyMembershipRolesRequest ¶
type ModifyMembershipRolesRequest struct { // AddRoles: The `MembershipRole`s to be added. // // Adding or removing roles in the same request as updating roles is // not // supported. // // Must not be set if `update_roles_params` is set. AddRoles []*MembershipRole `json:"addRoles,omitempty"` // RemoveRoles: The `name`s of the `MembershipRole`s to be // removed. // // Adding or removing roles in the same request as updating roles is // not // supported. // // It is not possible to remove the `MEMBER` `MembershipRole`. If you // wish to // delete a `Membership`, call // MembershipsService.DeleteMembership // instead. // // Must not contain `MEMBER`. Must not be set if `update_roles_params` // is set. RemoveRoles []string `json:"removeRoles,omitempty"` // UpdateRolesParams: The `MembershipRole`s to be updated. // // Updating roles in the same request as adding or removing roles is // not // supported. // // Must not be set if either `add_roles` or `remove_roles` is set. UpdateRolesParams []*UpdateMembershipRolesParams `json:"updateRolesParams,omitempty"` // ForceSendFields is a list of field names (e.g. "AddRoles") 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. "AddRoles") 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:"-"` }
ModifyMembershipRolesRequest: The request message for MembershipsService.ModifyMembershipRoles.
func (*ModifyMembershipRolesRequest) MarshalJSON ¶
func (s *ModifyMembershipRolesRequest) MarshalJSON() ([]byte, error)
type ModifyMembershipRolesResponse ¶
type ModifyMembershipRolesResponse struct { // Membership: The `Membership` resource after modifying its // `MembershipRole`s. Membership *Membership `json:"membership,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Membership") 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. "Membership") 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:"-"` }
ModifyMembershipRolesResponse: The response message for MembershipsService.ModifyMembershipRoles.
func (*ModifyMembershipRolesResponse) MarshalJSON ¶
func (s *ModifyMembershipRolesResponse) MarshalJSON() ([]byte, error)
type Operation ¶
type Operation struct { // Done: 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. Done bool `json:"done,omitempty"` // Error: The error result of the operation in case of failure or // cancellation. Error *Status `json:"error,omitempty"` // 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. Metadata googleapi.RawMessage `json:"metadata,omitempty"` // Name: 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}`. Name string `json:"name,omitempty"` // Response: The normal response of the operation in case of success. // 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`. Response googleapi.RawMessage `json:"response,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Done") 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. "Done") 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:"-"` }
Operation: This resource represents a long-running operation that is the result of a network API call.
func (*Operation) MarshalJSON ¶
type SearchGroupsResponse ¶
type SearchGroupsResponse struct { // Groups: The `Group`s that match the search query. Groups []*Group `json:"groups,omitempty"` // NextPageToken: A continuation token to retrieve the next page of // results, or empty if // there are no more results available. 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. "Groups") 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. "Groups") 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:"-"` }
SearchGroupsResponse: The response message for GroupsService.SearchGroups.
func (*SearchGroupsResponse) MarshalJSON ¶
func (s *SearchGroupsResponse) MarshalJSON() ([]byte, error)
type Service ¶
type Service struct { BasePath string // API endpoint base URL UserAgent string // optional additional User-Agent fragment Groups *GroupsService // 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 Status ¶
type Status struct { // Code: The status code, which should be an enum value of // google.rpc.Code. Code int64 `json:"code,omitempty"` // Details: A list of messages that carry the error details. There is a // common set of // message types for APIs to use. Details []googleapi.RawMessage `json:"details,omitempty"` // Message: 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. Message string `json:"message,omitempty"` // ForceSendFields is a list of field names (e.g. "Code") 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. "Code") 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:"-"` }
Status: 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).
func (*Status) MarshalJSON ¶
type UpdateMembershipRolesParams ¶
type UpdateMembershipRolesParams struct { // FieldMask: The fully-qualified names of fields to update. // // May only contain the field `expiry_detail`. FieldMask string `json:"fieldMask,omitempty"` // MembershipRole: The `MembershipRole`s to be updated. // // Only `MEMBER` `MembershipRoles` can currently be updated. // // May only contain a `MembershipRole` with `name` `MEMBER`. MembershipRole *MembershipRole `json:"membershipRole,omitempty"` // ForceSendFields is a list of field names (e.g. "FieldMask") 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. "FieldMask") 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:"-"` }
UpdateMembershipRolesParams: The details of an update to a `MembershipRole`.
func (*UpdateMembershipRolesParams) MarshalJSON ¶
func (s *UpdateMembershipRolesParams) MarshalJSON() ([]byte, error)