Looks up resource name of a Group by its EntityKey.
Name | Data Type | Description |
---|---|---|
groupKey.namespace
|
string |
Namespaces provide isolation for IDs, so an ID only needs to be unique within its namespace. Namespaces are currently only created as part of IdentitySource creation
from Admin Console. A namespace |
groupKey.id
|
string |
The ID of the entity within the given namespace. The ID must be unique within its namespace. |
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
LookupGroupNameResponse | ||||||||
Properties
|
Searches for Groups.
Name | Data Type | Description |
---|---|---|
view
|
string Allowed values: - VIEW_UNSPECIFIED - BASIC - FULL |
Group resource view to be returned. Defaults to [View.BASIC](). |
query
|
string |
|
pageToken
|
string |
The next_page_token value returned from a previous search request, if any. |
pageSize
|
integer |
The default page size is 200 (max 1000) for the BASIC view, and 50 (max 500) for the FULL view. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
SearchGroupsResponse | ||||||||||||||||||||||||||||||||||||||||||
Properties
|
List groups within a customer or a domain.
Name | Data Type | Description |
---|---|---|
view
|
string Allowed values: - VIEW_UNSPECIFIED - BASIC - FULL |
Group resource view to be returned. Defaults to [View.BASIC](). |
parent
|
string |
|
pageToken
|
string |
The next_page_token value returned from a previous list request, if any. |
pageSize
|
integer |
The default page size is 200 (max 1000) for the BASIC view, and 50 (max 500) for the FULL view. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ListGroupsResponse | ||||||||||||||||||||||||||||||||||||||||||
Properties
|
Creates a Group.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Operation | ||||||||||||||||||||||||||||||||||||
Properties
|
Deletes a Membership.
Name | Data Type | Description |
---|---|---|
name
|
string |
Resource name of the Membership to be deleted. Format: |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Operation | ||||||||||||||||||||||||||||||||||||
Properties
|
Retrieves a Membership.
Name | Data Type | Description |
---|---|---|
name
|
string |
Resource name of the Membership to be retrieved. Format: |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Membership | |||||||||||||||||||||||||||||||||||||||||||
Properties
|
Updates a Group.
Name | Data Type | Description |
---|---|---|
name
|
string |
Output only. Resource name of the
Group in the format: Must be left blank while creating a Group. |
Name | Data Type | Description |
---|---|---|
updateMask
|
string |
Editable fields: |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Group | ||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Operation | ||||||||||||||||||||||||||||||||||||
Properties
|
Looks up resource name of a Membership within a Group by member's EntityKey.
Name | Data Type | Description |
---|---|---|
parent
|
string |
Resource name of the Group to lookup Membership within. Format: |
Name | Data Type | Description |
---|---|---|
memberKey.namespace
|
string |
Namespaces provide isolation for IDs, so an ID only needs to be unique within its namespace. Namespaces are currently only created as part of IdentitySource creation
from Admin Console. A namespace |
memberKey.id
|
string |
The ID of the entity within the given namespace. The ID must be unique within its namespace. |
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
LookupMembershipNameResponse | ||||||||
Properties
|
List Memberships within a Group.
Name | Data Type | Description |
---|---|---|
parent
|
string |
Resource name of the Group to list Memberships within. Format: |
Name | Data Type | Description |
---|---|---|
view
|
string Allowed values: - VIEW_UNSPECIFIED - BASIC - FULL |
Membership resource view to be returned. Defaults to View.BASIC. |
pageToken
|
string |
The next_page_token value returned from a previous list request, if any. |
pageSize
|
integer |
The default page size is 200 (max 1000) for the BASIC view, and 50 (max 500) for the FULL view. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ListMembershipsResponse | |||||||||||||||||||||||||||||||||
Properties
|
Creates a Membership.
Name | Data Type | Description |
---|---|---|
parent
|
string |
Resource name of the
Group to create Membership within. Format: |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Membership | |||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Operation | ||||||||||||||||||||||||||||||||||||
Properties
|
An EntityKey uniquely identifies an Entity. Namespaces are used to provide isolation for IDs. A single ID can be reused across namespaces but the combination of a namespace and an ID must be unique.
Name | Data Type | Description |
---|---|---|
namespace
|
string |
Namespaces provide isolation for IDs, so an ID only needs to be unique within its namespace. Namespaces are currently only created as part of IdentitySource creation
from Admin Console. A namespace |
id
|
string |
The ID of the entity within the given namespace. The ID must be unique within its namespace. |
Resource representing a Group.
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
updateTime
|
string |
Output only. The time when the Group was last updated. Output only. |
||||||||||
parent
|
string |
Required. Immutable. The entity under which this Group resides in Cloud Identity resource hierarchy. Must be set when creating a Group, read-only afterwards. Currently allowed types: |
||||||||||
name
|
string |
Output only. Resource name of the
Group in the format: Must be left blank while creating a Group. |
||||||||||
labels
|
object |
Required. |
||||||||||
groupKey
|
EntityKey |
Required. Immutable. EntityKey of the Group. Must be set when creating a Group, read-only afterwards. |
||||||||||
Properties
|
||||||||||||
displayName
|
string |
The Group's display name. |
||||||||||
description
|
string |
An extended description to help users determine the purpose of a Group. For example, you can include information about who should join the Group, the types of messages to send to the Group, links to FAQs about the Group, or related Groups. Maximum length is 4,096 characters. |
||||||||||
createTime
|
string |
Output only. The time when the Group was created. Output only. |
Response message for ListGroups operation.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
nextPageToken
|
string |
Token to retrieve the next page of results, or empty if there are no more results available for listing. |
|||||||||||||||||||||||||||||||||||||||||
groups
|
array [Group] |
Groups returned in response to list request. The results are not sorted. |
|||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
nextPageToken
|
string |
Token to retrieve the next page of results, or empty if there are no more results available for listing. |
||||||||||||||||||||||||||||||||||||||||||
memberships
|
array [Membership] |
List of Memberships. |
||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
name
|
string |
Resource name of the
Group in the format: |
Name | Data Type | Description |
---|---|---|
name
|
string |
Resource name of the Membership being looked up. Format: |
Resource representing a Membership within a Group
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
updateTime
|
string |
Output only. Last updated timestamp of the Membership. Output only. |
||||||||||
roles
|
array [MembershipRole] |
Roles for a member within the Group. Currently supported MembershipRoles: |
||||||||||
Properties
|
||||||||||||
preferredMemberKey
|
EntityKey |
Required. Immutable. EntityKey of the entity to be added as the member. Must be set while creating a Membership, read-only afterwards. Currently allowed entity types: |
||||||||||
Properties
|
||||||||||||
name
|
string |
Output only. Resource name of the
Membership in the format: Must be left blank while creating a Membership. |
||||||||||
createTime
|
string |
Output only. Creation timestamp of the Membership. Output only. |
Resource representing a role within a Membership.
Name | Data Type | Description |
---|---|---|
name
|
string |
MembershipRole in string format. Currently supported MembershipRoles: |
This resource represents a long-running operation that is the result of a network API call.
Name | Data Type | Description | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
response
|
object |
The normal response of the operation in case of success. If the original
method returns no data on success, such as |
|||||||||||||
name
|
string |
The server-assigned name, which is only unique within the same service that
originally returns it. If you use the default HTTP mapping, the
|
|||||||||||||
metadata
|
object |
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. |
|||||||||||||
error
|
Status |
The error result of the operation in case of failure or cancellation. |
|||||||||||||
Properties
|
|||||||||||||||
done
|
boolean |
If the value is |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
nextPageToken
|
string |
Token to retrieve the next page of results, or empty if there are no more results available for specified query. |
|||||||||||||||||||||||||||||||||||||||||
groups
|
array [Group] |
List of Groups satisfying the search query. |
|||||||||||||||||||||||||||||||||||||||||
Properties
|
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. 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.
Name | Data Type | Description |
---|---|---|
message
|
string |
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
details
|
array [object] |
A list of messages that carry the error details. There is a common set of message types for APIs to use. |
code
|
integer |
The status code, which should be an enum value of google.rpc.Code. |
'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1
Oauth 2.0 accessCode authentication
Flow:authorizationCode
https://accounts.google.com/o/oauth2/auth
https://accounts.google.com/o/oauth2/token
https://www.googleapis.com/auth/cloud-platform
: View and manage your data across Google Cloud Platform serviceshttps://www.googleapis.com/auth/cloud-identity.groups
: See, change, create, and delete any of the Cloud Identity Groups that you can access, including the members of each grouphttps://www.googleapis.com/auth/cloud-identity.groups.readonly
: See any Cloud Identity Groups that you can access, including group members and their emails
'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1
Oauth 2.0 implicit authentication
Flow:implicit
https://accounts.google.com/o/oauth2/auth
https://www.googleapis.com/auth/cloud-platform
: View and manage your data across Google Cloud Platform serviceshttps://www.googleapis.com/auth/cloud-identity.groups
: See, change, create, and delete any of the Cloud Identity Groups that you can access, including the members of each grouphttps://www.googleapis.com/auth/cloud-identity.groups.readonly
: See any Cloud Identity Groups that you can access, including group members and their emailsName | Google |
External URL | https://google.com |
OAS (OpenAPI Specification) | v3.0.0 |