Discovery Engine API (discoveryengine:v1beta)

Additions

Methods


• ▼ ▲ discoveryengine.projects.locations.identityMappingStores.create

  Path : v1beta/{+parent}/identityMappingStores

  Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/identityMappingStores

  HTTP Method : POST

  Parameters :

  parent

  Description : Required. The parent collection resource name, such as `projects/{project}/locations/{location}`.

  Pattern : ^projects/[^/]+/locations/[^/]+$

  Location : path

  Required : Yes

  Type : string

  cmekConfigName

  Description : Resource name of the CmekConfig to use for protecting this Identity Mapping Store.

  Location : query

  Type : string

  disableCmek

  Description : Identity Mapping Store without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well.

  Location : query

  Type : boolean

  identityMappingStoreId

  Description : Required. The ID of the Identity Mapping Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters.

  Location : query

  Type : string

  Parameter Order : parent

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

  Description : Creates a new Identity Mapping Store.

• ▼ ▲ discoveryengine.projects.locations.identityMappingStores.get

  Path : v1beta/{+name}

  Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}

  HTTP Method : GET

  Parameters :

  name

  Description : Required. The name of the Identity Mapping Store to get. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`

  Pattern : ^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$

  Location : path

  Required : Yes

  Type : string

  Parameter Order : name

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

  Description : Gets the Identity Mapping Store.

• ▼ ▲ discoveryengine.projects.locations.identityMappingStores.delete

  Path : v1beta/{+name}

  Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}

  HTTP Method : DELETE

  Parameters :

  name

  Description : Required. The name of the Identity Mapping Store to delete. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`

  Pattern : ^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$

  Location : path

  Required : Yes

  Type : string

  Parameter Order : name

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

  Description : Deletes the Identity Mapping Store.

• ▼ ▲ discoveryengine.projects.locations.identityMappingStores.importIdentityMappings

  Path : v1beta/{+identityMappingStore}:importIdentityMappings

  Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}:importIdentityMappings

  HTTP Method : POST

  Parameters :

  identityMappingStore

  Description : Required. The name of the Identity Mapping Store to import Identity Mapping Entries to. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`

  Pattern : ^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$

  Location : path

  Required : Yes

  Type : string

  Parameter Order : identityMappingStore

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

  Description : Imports a list of Identity Mapping Entries to an Identity Mapping Store.

• ▼ ▲ discoveryengine.projects.locations.identityMappingStores.purgeIdentityMappings

  Path : v1beta/{+identityMappingStore}:purgeIdentityMappings

  Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}:purgeIdentityMappings

  HTTP Method : POST

  Parameters :

  identityMappingStore

  Description : Required. The name of the Identity Mapping Store to purge Identity Mapping Entries from. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`

  Pattern : ^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$

  Location : path

  Required : Yes

  Type : string

  Parameter Order : identityMappingStore

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

  Description : Purges specified or all Identity Mapping Entries from an Identity Mapping Store.

• ▼ ▲ discoveryengine.projects.locations.identityMappingStores.listIdentityMappings

  Path : v1beta/{+identityMappingStore}:listIdentityMappings

  Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}:listIdentityMappings

  HTTP Method : GET

  Parameters :

  identityMappingStore

  Description : Required. The name of the Identity Mapping Store to list Identity Mapping Entries in. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`

  Pattern : ^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$

  Location : path

  Required : Yes

  Type : string

  pageSize

  Description : Maximum number of IdentityMappings to return. If unspecified, defaults to 2000. The maximum allowed value is 10000. Values above 10000 will be coerced to 10000.

  Location : query

  Type : integer

  Format : int32

  pageToken

  Description : A page token, received from a previous `ListIdentityMappings` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityMappings` must match the call that provided the page token.

  Location : query

  Type : string

  Parameter Order : identityMappingStore

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

  Description : Lists Identity Mappings in an Identity Mapping Store.

• ▼ ▲ discoveryengine.projects.locations.identityMappingStores.list

  Path : v1beta/{+parent}/identityMappingStores

  Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/identityMappingStores

  HTTP Method : GET

  Parameters :

  parent

  Description : Required. The parent of the Identity Mapping Stores to list. Format: `projects/{project}/locations/{location}`.

  Pattern : ^projects/[^/]+/locations/[^/]+$

  Location : path

  Required : Yes

  Type : string

  pageSize

  Description : Maximum number of IdentityMappingStores to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.

  Location : query

  Type : integer

  Format : int32

  pageToken

  Description : A page token, received from a previous `ListIdentityMappingStores` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityMappingStores` must match the call that provided the page token.

  Location : query

  Type : string

  Parameter Order : parent

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

  Description : Lists all Identity Mapping Stores.