Liking cljdoc? Tell your friends :D

happygapi.cloudidentity.groups

Cloud Identity API: groups. API for provisioning and managing identity resources. See: https://cloud.google.com/identity/api/reference/rest/v1/groups

Cloud Identity API: groups.
API for provisioning and managing identity resources.
See: https://cloud.google.com/identity/api/reference/rest/v1/groups
raw docstring

create$clj

(create$ auth parameters body)

https://cloud.google.com/identity/api/reference/rest/v1/groups/create

Required parameters: none

Optional parameters: initialGroupConfig

Body:

{:description string, :labels {}, :parent string, :displayName string, :name string, :createTime string, :updateTime string, :dynamicGroupMetadata {:queries [DynamicGroupQuery], :status DynamicGroupStatus}, :groupKey {:id string, :namespace string}}

Creates a Group.

https://cloud.google.com/identity/api/reference/rest/v1/groups/create

Required parameters: none

Optional parameters: initialGroupConfig

Body: 

{:description string,
 :labels {},
 :parent string,
 :displayName string,
 :name string,
 :createTime string,
 :updateTime string,
 :dynamicGroupMetadata {:queries [DynamicGroupQuery],
                        :status DynamicGroupStatus},
 :groupKey {:id string, :namespace string}}

Creates a Group.
sourceraw docstring

delete$clj

(delete$ auth parameters)

https://cloud.google.com/identity/api/reference/rest/v1/groups/delete

Required parameters: name

Optional parameters: none

Deletes a Group.

https://cloud.google.com/identity/api/reference/rest/v1/groups/delete

Required parameters: name

Optional parameters: none

Deletes a `Group`.
sourceraw docstring

get$clj

(get$ auth parameters)

https://cloud.google.com/identity/api/reference/rest/v1/groups/get

Required parameters: name

Optional parameters: none

Retrieves a Group.

https://cloud.google.com/identity/api/reference/rest/v1/groups/get

Required parameters: name

Optional parameters: none

Retrieves a `Group`.
sourceraw docstring

list$clj

(list$ auth parameters)

https://cloud.google.com/identity/api/reference/rest/v1/groups/list

Required parameters: none

Optional parameters: view, parent, pageToken, pageSize

Lists the Group resources under a customer or namespace.

https://cloud.google.com/identity/api/reference/rest/v1/groups/list

Required parameters: none

Optional parameters: view, parent, pageToken, pageSize

Lists the `Group` resources under a customer or namespace.
sourceraw docstring

lookup$clj

(lookup$ auth parameters)

https://cloud.google.com/identity/api/reference/rest/v1/groups/lookup

Required parameters: none

Optional parameters: groupKey.id, groupKey.namespace

Looks up the resource name of a Group by its EntityKey.

https://cloud.google.com/identity/api/reference/rest/v1/groups/lookup

Required parameters: none

Optional parameters: groupKey.id, groupKey.namespace

Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Group` by its `EntityKey`.
sourceraw docstring

memberships-checkTransitiveMembership$clj

(memberships-checkTransitiveMembership$ auth parameters)

https://cloud.google.com/identity/api/reference/rest/v1/groups/memberships/checkTransitiveMembership

Required parameters: parent

Optional parameters: query

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.

https://cloud.google.com/identity/api/reference/rest/v1/groups/memberships/checkTransitiveMembership

Required parameters: parent

Optional parameters: query

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.
sourceraw docstring

memberships-create$clj

(memberships-create$ auth parameters body)

https://cloud.google.com/identity/api/reference/rest/v1/groups/memberships/create

Required parameters: parent

Optional parameters: none

Body:

{:name string, :preferredMemberKey {:id string, :namespace string}, :type string, :roles [{:name string, :expiryDetail ExpiryDetail}], :createTime string, :updateTime string}

Creates a Membership.

https://cloud.google.com/identity/api/reference/rest/v1/groups/memberships/create

Required parameters: parent

Optional parameters: none

Body: 

{:name string,
 :preferredMemberKey {:id string, :namespace string},
 :type string,
 :roles [{:name string, :expiryDetail ExpiryDetail}],
 :createTime string,
 :updateTime string}

Creates a `Membership`.
sourceraw docstring

memberships-delete$clj

(memberships-delete$ auth parameters)

https://cloud.google.com/identity/api/reference/rest/v1/groups/memberships/delete

Required parameters: name

Optional parameters: none

Deletes a Membership.

https://cloud.google.com/identity/api/reference/rest/v1/groups/memberships/delete

Required parameters: name

Optional parameters: none

Deletes a `Membership`.
sourceraw docstring

memberships-get$clj

(memberships-get$ auth parameters)

https://cloud.google.com/identity/api/reference/rest/v1/groups/memberships/get

Required parameters: name

Optional parameters: none

Retrieves a Membership.

https://cloud.google.com/identity/api/reference/rest/v1/groups/memberships/get

Required parameters: name

Optional parameters: none

Retrieves a `Membership`.
sourceraw docstring

memberships-getMembershipGraph$clj

(memberships-getMembershipGraph$ auth parameters)

https://cloud.google.com/identity/api/reference/rest/v1/groups/memberships/getMembershipGraph

Required parameters: parent

Optional parameters: query

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.

https://cloud.google.com/identity/api/reference/rest/v1/groups/memberships/getMembershipGraph

Required parameters: parent

Optional parameters: query

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.
sourceraw docstring

memberships-list$clj

(memberships-list$ auth parameters)

https://cloud.google.com/identity/api/reference/rest/v1/groups/memberships/list

Required parameters: parent

Optional parameters: view, pageToken, pageSize

Lists the Memberships within a Group.

https://cloud.google.com/identity/api/reference/rest/v1/groups/memberships/list

Required parameters: parent

Optional parameters: view, pageToken, pageSize

Lists the `Membership`s within a `Group`.
sourceraw docstring

memberships-lookup$clj

(memberships-lookup$ auth parameters)

https://cloud.google.com/identity/api/reference/rest/v1/groups/memberships/lookup

Required parameters: parent

Optional parameters: memberKey.namespace, memberKey.id

Looks up the resource name of a Membership by its EntityKey.

https://cloud.google.com/identity/api/reference/rest/v1/groups/memberships/lookup

Required parameters: parent

Optional parameters: memberKey.namespace, memberKey.id

Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Membership` by its `EntityKey`.
sourceraw docstring

memberships-modifyMembershipRoles$clj

(memberships-modifyMembershipRoles$ auth parameters body)

https://cloud.google.com/identity/api/reference/rest/v1/groups/memberships/modifyMembershipRoles

Required parameters: name

Optional parameters: none

Body:

{:addRoles [{:name string, :expiryDetail ExpiryDetail}], :removeRoles [string], :updateRolesParams [{:fieldMask string, :membershipRole MembershipRole}]}

Modifies the MembershipRoles of a Membership.

https://cloud.google.com/identity/api/reference/rest/v1/groups/memberships/modifyMembershipRoles

Required parameters: name

Optional parameters: none

Body: 

{:addRoles [{:name string, :expiryDetail ExpiryDetail}],
 :removeRoles [string],
 :updateRolesParams [{:fieldMask string,
                      :membershipRole MembershipRole}]}

Modifies the `MembershipRole`s of a `Membership`.
sourceraw docstring

memberships-searchTransitiveGroups$clj

(memberships-searchTransitiveGroups$ auth parameters)

https://cloud.google.com/identity/api/reference/rest/v1/groups/memberships/searchTransitiveGroups

Required parameters: parent

Optional parameters: query, pageToken, pageSize

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.

https://cloud.google.com/identity/api/reference/rest/v1/groups/memberships/searchTransitiveGroups

Required parameters: parent

Optional parameters: query, pageToken, pageSize

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.
sourceraw docstring

memberships-searchTransitiveMemberships$clj

(memberships-searchTransitiveMemberships$ auth parameters)

https://cloud.google.com/identity/api/reference/rest/v1/groups/memberships/searchTransitiveMemberships

Required parameters: parent

Optional parameters: pageSize, pageToken

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.

https://cloud.google.com/identity/api/reference/rest/v1/groups/memberships/searchTransitiveMemberships

Required parameters: parent

Optional parameters: pageSize, pageToken

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.
sourceraw docstring

patch$clj

(patch$ auth parameters body)

https://cloud.google.com/identity/api/reference/rest/v1/groups/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:description string, :labels {}, :parent string, :displayName string, :name string, :createTime string, :updateTime string, :dynamicGroupMetadata {:queries [DynamicGroupQuery], :status DynamicGroupStatus}, :groupKey {:id string, :namespace string}}

Updates a Group.

https://cloud.google.com/identity/api/reference/rest/v1/groups/patch

Required parameters: name

Optional parameters: updateMask

Body: 

{:description string,
 :labels {},
 :parent string,
 :displayName string,
 :name string,
 :createTime string,
 :updateTime string,
 :dynamicGroupMetadata {:queries [DynamicGroupQuery],
                        :status DynamicGroupStatus},
 :groupKey {:id string, :namespace string}}

Updates a `Group`.
sourceraw docstring

search$clj

(search$ auth parameters)

https://cloud.google.com/identity/api/reference/rest/v1/groups/search

Required parameters: none

Optional parameters: view, query, pageToken, pageSize

Searches for Group resources matching a specified query.

https://cloud.google.com/identity/api/reference/rest/v1/groups/search

Required parameters: none

Optional parameters: view, query, pageToken, pageSize

Searches for `Group` resources matching a specified query.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close