REST Resource: projects.locations.instances.federationGroups

Resource: FederationGroup

A Federation Group is a subset of tenants that share a common set of characteristics or requirements.

JSON representation 
{
  "name": string,
  "display_name": string,
  "type": enum (FederationGroupType),
  "federated_instances": [
    string
  ]
}
Fields
name

string

Identifier. Resource name of the Federation Group. Format: projects/{project}/locations/{location}/instances/{instance}/federationGroups/{federation_group}
display_name

string

Required. The name of the Federation Group to create.
type

enum (FederationGroupType)

Required. The type of the Federation Group.
federated_instances[]

string

Required. The subtenants_resource_ids that need to be added to this Federation Group. Format: projects/{project}/locations/{location}/instances/{instance}

FederationGroupType

The types of the Federation Group.

Enums
FEDERATION_GROUP_TYPE_UNSPECIFIED Unspecified Federation Group type.
FEDERATION_GROUP_TYPE_DEFAULT Default Federation Group type.

Methods

create

 CreateFederationGroup method creates a new Federation group.

delete

 DeleteFederationGroup method deletes a Federation group.

get

 GetFederationGroup method gets a Federation group.

list

 ListFederationGroups method lists all Federation groups.

patch

 UpdateFederationGroup method updates a Federation group.