Method: instances.fetchFederationAccess

Full name: projects.locations.instances.fetchFederationAccess

instances.fetchFederationAccess method lists all the instances the authenticated user has access to and the operations they can perform over these instances.

HTTP request


GET https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{name}:fetchFederationAccess

Path parameters

Parameters
name

string

Required. The instance name. Format: projects/{project}/locations/{location}/instances/{instance}

Request body

The request body must be empty.

Response body

Response message for instances.fetchFederationAccess RPC.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "federatedInstanceAccessMetadata": [
    {
      object (FederatedInstanceAccessMetadata)
    }
  ]
}
Fields
federatedInstanceAccessMetadata[]

object (FederatedInstanceAccessMetadata)

Output only. The federated instance access metadata. This field contains a list of FederatedInstanceAccessMetadata objects, each of which represents the access metadata for a federated instance. The FederatedInstanceAccessMetadata object contains the federated instance and the operations that the user has permission to perform over the instance.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • chronicle.instances.permitFederationAccess

For more information, see the IAM documentation.

FederatedInstanceAccessMetadata

FederatedInstanceAccessMetadata represents the access metadata for a federated instance.

JSON representation 
{
  "federatedInstance": {
    object (Instance)
  },
  "permittedOperations": [
    enum (FederatedOperation)
  ]
}
Fields
federatedInstance

object (Instance)

The federated instance.
permittedOperations[]

enum (FederatedOperation)

The operations that the user has permission to perform over the federated instance.

FederatedOperation

FederatedOperation represents the operations that can be performed over a federated instance.

Enums
FEDERATED_OPERATION_UNSPECIFIED This value is used to indicate generic access on the federated instance. This means that the user has permission to login to the instance. (chronicle.instances.get IAM permission)