• Home
• com.google.apis
• google-api-services-cloudidentity
• v1-rev20241010-2.0.0
• source code
• CloudIdentity.Groups.Memberships.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.cloudidentity.v1.CloudIdentity.Groups.Memberships.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.cloudidentity.v1
Class CloudIdentity.Groups.Memberships



java.lang.Object


com.google.api.services.cloudidentity.v1.CloudIdentity.Groups.Memberships







Enclosing class:
CloudIdentity.Groups




public class CloudIdentity.Groups.Memberships
extends Object
The "memberships" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
CloudIdentity.Groups.Memberships.CheckTransitiveMembership 


class 
CloudIdentity.Groups.Memberships.Create 


class 
CloudIdentity.Groups.Memberships.Delete 


class 
CloudIdentity.Groups.Memberships.Get 


class 
CloudIdentity.Groups.Memberships.GetMembershipGraph 


class 
CloudIdentity.Groups.Memberships.List 


class 
CloudIdentity.Groups.Memberships.Lookup 


class 
CloudIdentity.Groups.Memberships.ModifyMembershipRoles 


class 
CloudIdentity.Groups.Memberships.SearchDirectGroups 


class 
CloudIdentity.Groups.Memberships.SearchTransitiveGroups 


class 
CloudIdentity.Groups.Memberships.SearchTransitiveMemberships 









Constructor Summary

Constructors 

Constructor and Description


Memberships() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


CloudIdentity.Groups.Memberships.CheckTransitiveMembership
checkTransitiveMembership(String parent)
Check a potential member for membership in a group.



CloudIdentity.Groups.Memberships.Create
create(String parent,
      Membership content)
Creates a `Membership`.



CloudIdentity.Groups.Memberships.Delete
delete(String name)
Deletes a `Membership`.



CloudIdentity.Groups.Memberships.Get
get(String name)
Retrieves a `Membership`.



CloudIdentity.Groups.Memberships.GetMembershipGraph
getMembershipGraph(String parent)
Get a membership graph of just a member or both a member and a group.



CloudIdentity.Groups.Memberships.List
list(String parent)
Lists the `Membership`s within a `Group`.



CloudIdentity.Groups.Memberships.Lookup
lookup(String parent)
Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a
 `Membership` by its `EntityKey`.



CloudIdentity.Groups.Memberships.ModifyMembershipRoles
modifyMembershipRoles(String name,
                     ModifyMembershipRolesRequest content)
Modifies the `MembershipRole`s of a `Membership`.



CloudIdentity.Groups.Memberships.SearchDirectGroups
searchDirectGroups(String parent)
Searches direct groups of a member.



CloudIdentity.Groups.Memberships.SearchTransitiveGroups
searchTransitiveGroups(String parent)
Search transitive groups of a member.



CloudIdentity.Groups.Memberships.SearchTransitiveMemberships
searchTransitiveMemberships(String parent)
Search transitive memberships of a group.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





Memberships
public Memberships()









Method Detail





checkTransitiveMembership
public CloudIdentity.Groups.Memberships.CheckTransitiveMembership checkTransitiveMembership(String parent)
                                                                                     throws IOException
Check a potential member for membership in a group. **Note:** This feature is only available to
 Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud
 Identity Premium accounts. If the account of the member is not one of these, a 403
 (PERMISSION_DENIED) HTTP status code will be returned. A member has membership to a group as long
 as there is a single viewable transitive membership between the group and the member. The actor
 must have view permissions to at least one transitive membership between the member and group.

 Create a request for the method "memberships.checkTransitiveMembership".

 This request holds the parameters needed by the cloudidentity server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
parent - [Resource name](https://cloud.google.com/apis/design/resource_names) of the group to check the
        transitive membership in. Format: `groups/{group}`, where `group` is the unique id
        assigned to the Group to which the Membership belongs to.
Returns:
the request
Throws:
IOException








create
public CloudIdentity.Groups.Memberships.Create create(String parent,
                                                      Membership content)
                                               throws IOException
Creates a `Membership`.

 Create a request for the method "memberships.create".

 This request holds the parameters needed by the cloudidentity server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
parent - Required. The parent `Group` resource under which to create the `Membership`. Must be of the form
        `groups/{group}`.
content - the Membership
Returns:
the request
Throws:
IOException








delete
public CloudIdentity.Groups.Memberships.Delete delete(String name)
                                               throws IOException
Deletes a `Membership`.

 Create a request for the method "memberships.delete".

 This request holds the parameters needed by the cloudidentity server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the
        `Membership` to delete. Must be of the form `groups/{group}/memberships/{membership}`
Returns:
the request
Throws:
IOException








get
public CloudIdentity.Groups.Memberships.Get get(String name)
                                         throws IOException
Retrieves a `Membership`.

 Create a request for the method "memberships.get".

 This request holds the parameters needed by the cloudidentity server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the
        `Membership` to retrieve. Must be of the form `groups/{group}/memberships/{membership}`.
Returns:
the request
Throws:
IOException








getMembershipGraph
public CloudIdentity.Groups.Memberships.GetMembershipGraph getMembershipGraph(String parent)
                                                                       throws IOException
Get a membership graph of just a member or both a member and a group. **Note:** This feature is
 only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for
 Education; and Cloud Identity Premium accounts. If the account of the member is not one of these,
 a 403 (PERMISSION_DENIED) HTTP status code will be returned. Given a member, the response will
 contain all membership paths from the member. Given both a group and a member, the response will
 contain all membership paths between the group and the member.

 Create a request for the method "memberships.getMembershipGraph".

 This request holds the parameters needed by the cloudidentity server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
parent - Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the group to
        search transitive memberships in. Format: `groups/{group}`, where `group` is the unique ID
        assigned to the Group to which the Membership belongs to. group can be a wildcard
        collection id "-". When a group is specified, the membership graph will be constrained to
        paths between the member (defined in the query) and the parent. If a wildcard collection
        is provided, all membership paths connected to the member will be returned.
Returns:
the request
Throws:
IOException








list
public CloudIdentity.Groups.Memberships.List list(String parent)
                                           throws IOException
Lists the `Membership`s within a `Group`.

 Create a request for the method "memberships.list".

 This request holds the parameters needed by the cloudidentity server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
parent - Required. The parent `Group` resource under which to lookup the `Membership` name. Must be of the
        form `groups/{group}`.
Returns:
the request
Throws:
IOException








lookup
public CloudIdentity.Groups.Memberships.Lookup lookup(String parent)
                                               throws IOException
Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a
 `Membership` by its `EntityKey`.

 Create a request for the method "memberships.lookup".

 This request holds the parameters needed by the cloudidentity server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
parent - Required. The parent `Group` resource under which to lookup the `Membership` name. Must be of the
        form `groups/{group}`.
Returns:
the request
Throws:
IOException








modifyMembershipRoles
public CloudIdentity.Groups.Memberships.ModifyMembershipRoles modifyMembershipRoles(String name,
                                                                                    ModifyMembershipRolesRequest content)
                                                                             throws IOException
Modifies the `MembershipRole`s of a `Membership`.

 Create a request for the method "memberships.modifyMembershipRoles".

 This request holds the parameters needed by the cloudidentity server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
name - Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the
        `Membership` whose roles are to be modified. Must be of the form
        `groups/{group}/memberships/{membership}`.
content - the ModifyMembershipRolesRequest
Returns:
the request
Throws:
IOException








searchDirectGroups
public CloudIdentity.Groups.Memberships.SearchDirectGroups searchDirectGroups(String parent)
                                                                       throws IOException
Searches direct groups of a member.

 Create a request for the method "memberships.searchDirectGroups".

 This request holds the parameters needed by the cloudidentity server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
parent - [Resource name](https://cloud.google.com/apis/design/resource_names) of the group to search
        transitive memberships in. Format: groups/{group_id}, where group_id is always '-' as this
        API will search across all groups for a given member.
Returns:
the request
Throws:
IOException








searchTransitiveGroups
public CloudIdentity.Groups.Memberships.SearchTransitiveGroups searchTransitiveGroups(String parent)
                                                                               throws IOException
Search transitive groups of a member. **Note:** This feature is only available to Google
 Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity
 Premium accounts. If the account of the member is not one of these, a 403 (PERMISSION_DENIED)
 HTTP status code will be returned. A transitive group is any group that has a direct or indirect
 membership to the member. Actor must have view permissions all transitive groups.

 Create a request for the method "memberships.searchTransitiveGroups".

 This request holds the parameters needed by the cloudidentity server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
parent - [Resource name](https://cloud.google.com/apis/design/resource_names) of the group to search
        transitive memberships in. Format: `groups/{group}`, where `group` is always '-' as this
        API will search across all groups for a given member.
Returns:
the request
Throws:
IOException








searchTransitiveMemberships
public CloudIdentity.Groups.Memberships.SearchTransitiveMemberships searchTransitiveMemberships(String parent)
                                                                                         throws IOException
Search transitive memberships of a group. **Note:** This feature is only available to Google
 Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity
 Premium accounts. If the account of the group is not one of these, a 403 (PERMISSION_DENIED) HTTP
 status code will be returned. A transitive membership is any direct or indirect membership of a
 group. Actor must have view permissions to all transitive memberships.

 Create a request for the method "memberships.searchTransitiveMemberships".

 This request holds the parameters needed by the cloudidentity server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
parent - [Resource name](https://cloud.google.com/apis/design/resource_names) of the group to search
        transitive memberships in. Format: `groups/{group}`, where `group` is the unique ID
        assigned to the Group.
Returns:
the request
Throws:
IOException














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.