Google - API Cloud Identity

Google / Cloud Identity

Cloud Identity

API for provisioning and managing identity resources.

License: Creative Commons Attribution 3.0

Resources

groups

GET

/v1/groups:lookup

Looks up resource name of a Group by its EntityKey.

Request

Query

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 `"identitysources/{identity_source_id}"` is created corresponding to every Identity Source `identity_source_id`.
`groupKey.id`	string	The ID of the entity within the given namespace. The ID must be unique within its namespace.

Responses

200Successful response

Body

Name Data Type Description

LookupGroupNameResponse

LookupGroupNameResponse object

Properties


                        name

string

Resource name of the Group in the format: groups/{group_id}, where group_id is the unique ID assigned to the Group.

GET

/v1/groups:search

Searches for Groups.

Request

Query

Name	Data Type	Description
`view`	string Allowed values: - `VIEW_UNSPECIFIED` - `BASIC` - `FULL`	Group resource view to be returned. Defaults to [View.BASIC]().
`query`	string	`Required`. Query string for performing search on groups. Users can search on parent and label attributes of groups. EXACT match ('==') is supported on parent, and CONTAINS match ('in') is supported on labels.
`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.

Responses

200Successful response

Body

Name Data Type Description

SearchGroupsResponse

SearchGroupsResponse object

Properties


                        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.


                        Group

object

Resource representing a Group.

Properties

`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: `identitysources`.
`name`	string	Output only. Resource name of the Group in the format: `groups/{group_id}`, where group_id is the unique ID assigned to the Group. Must be left blank while creating a Group.
`labels`	object	Required. `Required`. Labels for Group resource. For creating Groups under a namespace, set label key to 'labels/system/groups/external' and label value as empty.
`groupKey`	EntityKey	Required. Immutable. EntityKey of the Group. Must be set when creating a Group, read-only afterwards.
`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.

GET

/v1/groups

List groups within a customer or a domain.

Request

Query

Name	Data Type	Description
`view`	string Allowed values: - `VIEW_UNSPECIFIED` - `BASIC` - `FULL`	Group resource view to be returned. Defaults to [View.BASIC]().
`parent`	string	`Required`. May be made Optional in the future. Customer ID to list all groups from.
`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.

Responses

200Successful response

Body

Name Data Type Description

ListGroupsResponse


                        ListGroupsResponse

object

Response message for ListGroups operation.

Properties


                        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.


                        Group

object

Resource representing a Group.

Properties

`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: `identitysources`.
`name`	string	Output only. Resource name of the Group in the format: `groups/{group_id}`, where group_id is the unique ID assigned to the Group. Must be left blank while creating a Group.
`labels`	object	Required. `Required`. Labels for Group resource. For creating Groups under a namespace, set label key to 'labels/system/groups/external' and label value as empty.
`groupKey`	EntityKey	Required. Immutable. EntityKey of the Group. Must be set when creating a Group, read-only afterwards.
`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.

POST

/v1/groups

Creates a Group.

Request

Body

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This resource represents a long-running operation that is the result of a network API call.

Properties


                        response

object

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.


                        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 name should be a resource name ending with operations/{unique_id}.


                        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.


                        Status

object

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.

Properties

`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.


                        done

boolean

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.

DELETE

/v1/{name}

Deletes a Membership.

Request

Path

Name	Data Type	Description
`name`	string	Resource name of the Membership to be deleted. Format: `groups/{group_id}/memberships/{member_id}`, where `group_id` is the unique ID assigned to the Group to which Membership belongs to, and member_id is the unique ID assigned to the member.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This resource represents a long-running operation that is the result of a network API call.

Properties


                        response

object


                        name

string


                        metadata

object


                        error

Status

The error result of the operation in case of failure or cancellation.


                        Status

object

You can find out more about this error model and how to work with it in the API Design Guide.

Properties

`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.


                        done

boolean

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.

GET

/v1/{name}

Retrieves a Membership.

Request

Path

Name	Data Type	Description
`name`	string	Resource name of the Membership to be retrieved. Format: `groups/{group_id}/memberships/{member_id}`, where `group_id` is the unique id assigned to the Group to which Membership belongs to, and `member_id` is the unique ID assigned to the member.

Responses

200Successful response

Body

Name Data Type Description

Membership


                        Membership

object

Resource representing a Membership within a Group

Properties


                        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: "MEMBER".


                        MembershipRole

object

Resource representing a role within a Membership.

Properties


                        name

string

MembershipRole in string format.

Currently supported MembershipRoles: "MEMBER".


                        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: Users, Groups.


                        EntityKey

object

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.

Properties

`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 `"identitysources/{identity_source_id}"` is created corresponding to every Identity Source `identity_source_id`.
`id`	string	The ID of the entity within the given namespace. The ID must be unique within its namespace.


                        name

string

Output only. Resource name of the Membership in the format: groups/{group_id}/memberships/{member_id}, where group_id is the unique ID assigned to the Group to which Membership belongs to, and member_id is the unique ID assigned to the member

Must be left blank while creating a Membership.


                        createTime

string

Output only. Creation timestamp of the Membership. Output only.

PATCH

/v1/{name}

Updates a Group.

Request

Path

Name	Data Type	Description
`name`	string	Output only. Resource name of the Group in the format: `groups/{group_id}`, where group_id is the unique ID assigned to the Group. Must be left blank while creating a Group.

Query

Name	Data Type	Description
`updateMask`	string	Editable fields: `display_name`, `description`

Body

Name Data Type Description

Group


                        Group

object

Resource representing a Group.

Properties


                        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: identitysources.


                        name

string

Output only. Resource name of the Group in the format: groups/{group_id}, where group_id is the unique ID assigned to the Group.

Must be left blank while creating a Group.


                        labels

object

Required. Required. Labels for Group resource. For creating Groups under a namespace, set label key to 'labels/system/groups/external' and label value as empty.


                        groupKey

EntityKey

Required. Immutable. EntityKey of the Group.

Must be set when creating a Group, read-only afterwards.


                        EntityKey

object

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.

Properties

`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 `"identitysources/{identity_source_id}"` is created corresponding to every Identity Source `identity_source_id`.
`id`	string	The ID of the entity within the given namespace. The ID must be unique within its namespace.


                        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.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This resource represents a long-running operation that is the result of a network API call.

Properties


                        response

object


                        name

string


                        metadata

object


                        error

Status

The error result of the operation in case of failure or cancellation.


                        Status

object

You can find out more about this error model and how to work with it in the API Design Guide.

Properties

`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.


                        done

boolean

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.

GET

/v1/{parent}/memberships:lookup

Looks up resource name of a Membership within a Group by member's EntityKey.

Request

Path

Name	Data Type	Description
`parent`	string	Resource name of the Group to lookup Membership within. Format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group.

Query

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 `"identitysources/{identity_source_id}"` is created corresponding to every Identity Source `identity_source_id`.
`memberKey.id`	string	The ID of the entity within the given namespace. The ID must be unique within its namespace.

Responses

200Successful response

Body

Name Data Type Description

LookupMembershipNameResponse

LookupMembershipNameResponse object

Properties


                        name

string

Resource name of the Membership being looked up.

Format: groups/{group_id}/memberships/{member_id}, where group_id is the unique ID assigned to the Group to which Membership belongs to, and member_id is the unique ID assigned to the member.

GET

/v1/{parent}/memberships

List Memberships within a Group.

Request

Path

Name	Data Type	Description
`parent`	string	Resource name of the Group to list Memberships within. Format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group.

Query

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.

Responses

200Successful response

Body

Name Data Type Description

ListMembershipsResponse

ListMembershipsResponse object

Properties


                        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.


                        Membership

object

Resource representing a Membership within a Group

Properties

`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: `"MEMBER"`.
`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: `Users`, `Groups`.
`name`	string	Output only. Resource name of the Membership in the format: `groups/{group_id}/memberships/{member_id}`, where group_id is the unique ID assigned to the Group to which Membership belongs to, and member_id is the unique ID assigned to the member Must be left blank while creating a Membership.
`createTime`	string	Output only. Creation timestamp of the Membership. Output only.

POST

/v1/{parent}/memberships

Creates a Membership.

Request

Path

Name	Data Type	Description
`parent`	string	Resource name of the Group to create Membership within. Format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group.

Body

Name Data Type Description

Membership


                        Membership

object

Resource representing a Membership within a Group

Properties


                        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: "MEMBER".


                        MembershipRole

object

Resource representing a role within a Membership.

Properties


                        name

string

MembershipRole in string format.

Currently supported MembershipRoles: "MEMBER".


                        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: Users, Groups.


                        EntityKey

object

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.

Properties

`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 `"identitysources/{identity_source_id}"` is created corresponding to every Identity Source `identity_source_id`.
`id`	string	The ID of the entity within the given namespace. The ID must be unique within its namespace.


                        name

string

Must be left blank while creating a Membership.


                        createTime

string

Output only. Creation timestamp of the Membership. Output only.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This resource represents a long-running operation that is the result of a network API call.

Properties


                        response

object


                        name

string


                        metadata

object


                        error

Status

The error result of the operation in case of failure or cancellation.


                        Status

object

You can find out more about this error model and how to work with it in the API Design Guide.

Properties

`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.


                        done

boolean

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.

Models

EntityKey

Group

Resource representing a Group.

Properties

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: identitysources.


                        name

string

Output only. Resource name of the Group in the format: groups/{group_id}, where group_id is the unique ID assigned to the Group.

Must be left blank while creating a Group.


                        labels

object

Required. Required. Labels for Group resource. For creating Groups under a namespace, set label key to 'labels/system/groups/external' and label value as empty.


                        groupKey

EntityKey

Required. Immutable. EntityKey of the Group.

Must be set when creating a Group, read-only afterwards.


                        EntityKey

object

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.

Properties

`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 `"identitysources/{identity_source_id}"` is created corresponding to every Identity Source `identity_source_id`.
`id`	string	The ID of the entity within the given namespace. The ID must be unique within its namespace.


                        displayName

string

The Group's display name.


                        description

string


                        createTime

string

Output only. The time when the Group was created. Output only.

ListGroupsResponse

Response message for ListGroups operation.

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.


                        groups

array [Group]

Groups returned in response to list request. The results are not sorted.


                        Group

object

Resource representing a Group.

Properties


                        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: identitysources.


                        name

string

Output only. Resource name of the Group in the format: groups/{group_id}, where group_id is the unique ID assigned to the Group.

Must be left blank while creating a Group.


                        labels

object

Required. Required. Labels for Group resource. For creating Groups under a namespace, set label key to 'labels/system/groups/external' and label value as empty.


                        groupKey

EntityKey

Required. Immutable. EntityKey of the Group.

Must be set when creating a Group, read-only afterwards.


                        EntityKey

object

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.

Properties

`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 `"identitysources/{identity_source_id}"` is created corresponding to every Identity Source `identity_source_id`.
`id`	string	The ID of the entity within the given namespace. The ID must be unique within its namespace.


                        displayName

string

The Group's display name.


                        description

string


                        createTime

string

Output only. The time when the Group was created. Output only.

ListMembershipsResponse

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.


                        Membership

object

Resource representing a Membership within a Group

Properties


                        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: "MEMBER".


                        MembershipRole

object

Resource representing a role within a Membership.

Properties


                        name

string

MembershipRole in string format.

Currently supported MembershipRoles: "MEMBER".


                        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: Users, Groups.


                        EntityKey

object

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.

Properties

`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 `"identitysources/{identity_source_id}"` is created corresponding to every Identity Source `identity_source_id`.
`id`	string	The ID of the entity within the given namespace. The ID must be unique within its namespace.


                        name

string

Must be left blank while creating a Membership.


                        createTime

string

Output only. Creation timestamp of the Membership. Output only.

LookupGroupNameResponse

LookupMembershipNameResponse

Membership

Resource representing a Membership within a Group

Properties

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: "MEMBER".


                        MembershipRole

object

Resource representing a role within a Membership.

Properties


                        name

string

MembershipRole in string format.

Currently supported MembershipRoles: "MEMBER".


                        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: Users, Groups.


                        EntityKey

object

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.

Properties

`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 `"identitysources/{identity_source_id}"` is created corresponding to every Identity Source `identity_source_id`.
`id`	string	The ID of the entity within the given namespace. The ID must be unique within its namespace.


                        name

string

Must be left blank while creating a Membership.


                        createTime

string

Output only. Creation timestamp of the Membership. Output only.

MembershipRole

Operation

This resource represents a long-running operation that is the result of a network API call.

Properties

Name Data Type Description


                        response

object


                        name

string


                        metadata

object


                        error

Status

The error result of the operation in case of failure or cancellation.


                        Status

object

You can find out more about this error model and how to work with it in the API Design Guide.

Properties

`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.


                        done

boolean

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.

SearchGroupsResponse

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 specified query.


                        groups

array [Group]

List of Groups satisfying the search query.


                        Group

object

Resource representing a Group.

Properties


                        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: identitysources.


                        name

string

Output only. Resource name of the Group in the format: groups/{group_id}, where group_id is the unique ID assigned to the Group.

Must be left blank while creating a Group.


                        labels

object

Required. Required. Labels for Group resource. For creating Groups under a namespace, set label key to 'labels/system/groups/external' and label value as empty.


                        groupKey

EntityKey

Required. Immutable. EntityKey of the Group.

Must be set when creating a Group, read-only afterwards.


                        EntityKey

object

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.

Properties

`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 `"identitysources/{identity_source_id}"` is created corresponding to every Identity Source `identity_source_id`.
`id`	string	The ID of the entity within the given namespace. The ID must be unique within its namespace.


                        displayName

string

The Group's display name.


                        description

string


                        createTime

string

Output only. The time when the Group was created. Output only.

Status

Authentication

Oauth2

'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1

Oauth 2.0 accessCode authentication

Flow: authorizationCode
Authorization URL: https://accounts.google.com/o/oauth2/auth
Token URL: https://accounts.google.com/o/oauth2/token
Scopes:

https://www.googleapis.com/auth/cloud-platform: View and manage your data across Google Cloud Platform services
https://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 group
https://www.googleapis.com/auth/cloud-identity.groups.readonly: See any Cloud Identity Groups that you can access, including group members and their emails

Oauth2

'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1

Oauth 2.0 implicit authentication

Flow: implicit
Authorization URL: https://accounts.google.com/o/oauth2/auth
Scopes:

https://www.googleapis.com/auth/cloud-platform: View and manage your data across Google Cloud Platform services
https://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 group
https://www.googleapis.com/auth/cloud-identity.groups.readonly: See any Cloud Identity Groups that you can access, including group members and their emails

Contact

Name	`Google`
External URL	`https://google.com`

Metadata (Technical Details)

OAS (OpenAPI Specification) v3.0.0

Comments

Loading comments ...