---
title: GoogleSecretManagerMappings
description: Resource path:
component: pingam
version: 8.1
page_id: pingam:entity-reference:sec-amster-entity-googlesecretmanagermappings
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-googlesecretmanagermappings.html
section_ids:
  sec-amster-entity-googlesecretmanagermappings-realm-ops: Realm Operations
  sec-amster-entity-googlesecretmanagermappings-realm-ops-create: create
  sec-amster-entity-googlesecretmanagermappings-realm-ops-delete: delete
  sec-amster-entity-googlesecretmanagermappings-realm-ops-getalltypes: getAllTypes
  sec-amster-entity-googlesecretmanagermappings-realm-ops-update: update
  sec-amster-entity-googlesecretmanagermappings-global-ops: Global Operations
  sec-amster-entity-googlesecretmanagermappings-global-ops-create: create
  sec-amster-entity-googlesecretmanagermappings-global-ops-delete: delete
  sec-amster-entity-googlesecretmanagermappings-global-ops-getalltypes: getAllTypes
  sec-amster-entity-googlesecretmanagermappings-global-ops-update: update
---

# GoogleSecretManagerMappings

## Realm Operations

Resource path:

```
/realm-config/secrets/stores/GoogleSecretManagerSecretStoreProvider/{GoogleSecretManagerSecretStoreProvider}/mappings
```

Resource version: `0.0`

### create

**Usage**

```
am> create GoogleSecretManagerMappings --realm Realm --GoogleSecretManagerSecretStoreProvider GoogleSecretManagerSecretStoreProvider --id id --body body
```

**Parameters**

* * *\--GoogleSecretManagerSecretStoreProvider*
  * *\--id*

  The unique identifier for the resource.

* *\--body*

  The resource in JSON format, described by the following JSON schema:

  ```json
  {
    "type" : "object",
    "properties" : {
      "aliases" : {
        "title" : "aliases",
        "description" : "",
        "propertyOrder" : 200,
        "required" : true,
        "items" : {
          "type" : "string",
          "minLength" : 1
        },
        "minItems" : 1,
        "uniqueItems" : true,
        "type" : "array",
        "exampleValue" : ""
      },
      "secretId" : {
        "title" : "Secret Label",
        "description" : "The secret label that is to be associated with a Secret Manager secret.",
        "propertyOrder" : 100,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      }
    }
  }
  ```

### delete

**Usage**

```
am> delete GoogleSecretManagerMappings --realm Realm --GoogleSecretManagerSecretStoreProvider GoogleSecretManagerSecretStoreProvider --id id
```

**Parameters**

* * *\--GoogleSecretManagerSecretStoreProvider*
  * *\--id*

  The unique identifier for the resource.

### getAllTypes

Obtain the collection of all secondary configuration types related to the resource.

**Usage**

```
am> action GoogleSecretManagerMappings --realm Realm --GoogleSecretManagerSecretStoreProvider GoogleSecretManagerSecretStoreProvider --actionName getAllTypes
```

**Parameters**

* *\--GoogleSecretManagerSecretStoreProvider*

  \=== getCreatableTypes

Obtain the collection of secondary configuration types that have yet to be added to the resource.

**Usage**

```
am> action GoogleSecretManagerMappings --realm Realm --GoogleSecretManagerSecretStoreProvider GoogleSecretManagerSecretStoreProvider --actionName getCreatableTypes
```

**Parameters**

* *\--GoogleSecretManagerSecretStoreProvider*

  \=== nextdescendents

Obtain the collection of secondary configuration instances that have been added to the resource.

**Usage**

```
am> action GoogleSecretManagerMappings --realm Realm --GoogleSecretManagerSecretStoreProvider GoogleSecretManagerSecretStoreProvider --actionName nextdescendents
```

**Parameters**

* *\--GoogleSecretManagerSecretStoreProvider*

  \=== query

Get the full list of instances of this collection. This query only supports `_queryFilter=true` filter.

**Usage**

```
am> query GoogleSecretManagerMappings --realm Realm --filter filter --GoogleSecretManagerSecretStoreProvider GoogleSecretManagerSecretStoreProvider
```

**Parameters**

* *\--filter*

  A CREST formatted query filter, where "true" will query all.

* *\--GoogleSecretManagerSecretStoreProvider*

  \=== read

**Usage**

```
am> read GoogleSecretManagerMappings --realm Realm --GoogleSecretManagerSecretStoreProvider GoogleSecretManagerSecretStoreProvider --id id
```

**Parameters**

* * *\--GoogleSecretManagerSecretStoreProvider*
  * *\--id*

  The unique identifier for the resource.

### update

**Usage**

```
am> update GoogleSecretManagerMappings --realm Realm --GoogleSecretManagerSecretStoreProvider GoogleSecretManagerSecretStoreProvider --id id --body body
```

**Parameters**

* * *\--GoogleSecretManagerSecretStoreProvider*
  * *\--id*

  The unique identifier for the resource.

* *\--body*

  The resource in JSON format, described by the following JSON schema:

  ```json
  {
    "type" : "object",
    "properties" : {
      "aliases" : {
        "title" : "aliases",
        "description" : "",
        "propertyOrder" : 200,
        "required" : true,
        "items" : {
          "type" : "string",
          "minLength" : 1
        },
        "minItems" : 1,
        "uniqueItems" : true,
        "type" : "array",
        "exampleValue" : ""
      },
      "secretId" : {
        "title" : "Secret Label",
        "description" : "The secret label that is to be associated with a Secret Manager secret.",
        "propertyOrder" : 100,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      }
    }
  }
  ```

## Global Operations

Resource path:

```
/global-config/secrets/stores/GoogleSecretManagerSecretStoreProvider/{GoogleSecretManagerSecretStoreProvider}/mappings
```

Resource version: `1.0`

### create

**Usage**

```
am> create GoogleSecretManagerMappings --global --GoogleSecretManagerSecretStoreProvider GoogleSecretManagerSecretStoreProvider --id id --body body
```

**Parameters**

* * *\--GoogleSecretManagerSecretStoreProvider*
  * *\--id*

  The unique identifier for the resource.

* *\--body*

  The resource in JSON format, described by the following JSON schema:

  ```json
  {
    "type" : "object",
    "properties" : {
      "secretId" : {
        "title" : "Secret Label",
        "description" : "The secret label that is to be associated with a Secret Manager secret.",
        "propertyOrder" : 100,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "aliases" : {
        "title" : "aliases",
        "description" : "",
        "propertyOrder" : 200,
        "required" : true,
        "items" : {
          "type" : "string",
          "minLength" : 1
        },
        "minItems" : 1,
        "uniqueItems" : true,
        "type" : "array",
        "exampleValue" : ""
      }
    }
  }
  ```

### delete

**Usage**

```
am> delete GoogleSecretManagerMappings --global --GoogleSecretManagerSecretStoreProvider GoogleSecretManagerSecretStoreProvider --id id
```

**Parameters**

* * *\--GoogleSecretManagerSecretStoreProvider*
  * *\--id*

  The unique identifier for the resource.

### getAllTypes

Obtain the collection of all secondary configuration types related to the resource.

**Usage**

```
am> action GoogleSecretManagerMappings --global --GoogleSecretManagerSecretStoreProvider GoogleSecretManagerSecretStoreProvider --actionName getAllTypes
```

**Parameters**

* *\--GoogleSecretManagerSecretStoreProvider*

  \=== getCreatableTypes

Obtain the collection of secondary configuration types that have yet to be added to the resource.

**Usage**

```
am> action GoogleSecretManagerMappings --global --GoogleSecretManagerSecretStoreProvider GoogleSecretManagerSecretStoreProvider --actionName getCreatableTypes
```

**Parameters**

* *\--GoogleSecretManagerSecretStoreProvider*

  \=== nextdescendents

Obtain the collection of secondary configuration instances that have been added to the resource.

**Usage**

```
am> action GoogleSecretManagerMappings --global --GoogleSecretManagerSecretStoreProvider GoogleSecretManagerSecretStoreProvider --actionName nextdescendents
```

**Parameters**

* *\--GoogleSecretManagerSecretStoreProvider*

  \=== query

Get the full list of instances of this collection. This query only supports `_queryFilter=true` filter.

**Usage**

```
am> query GoogleSecretManagerMappings --global --filter filter --GoogleSecretManagerSecretStoreProvider GoogleSecretManagerSecretStoreProvider
```

**Parameters**

* *\--filter*

  A CREST formatted query filter, where "true" will query all.

* *\--GoogleSecretManagerSecretStoreProvider*

  \=== read

**Usage**

```
am> read GoogleSecretManagerMappings --global --GoogleSecretManagerSecretStoreProvider GoogleSecretManagerSecretStoreProvider --id id
```

**Parameters**

* * *\--GoogleSecretManagerSecretStoreProvider*
  * *\--id*

  The unique identifier for the resource.

### update

**Usage**

```
am> update GoogleSecretManagerMappings --global --GoogleSecretManagerSecretStoreProvider GoogleSecretManagerSecretStoreProvider --id id --body body
```

**Parameters**

* * *\--GoogleSecretManagerSecretStoreProvider*
  * *\--id*

  The unique identifier for the resource.

* *\--body*

  The resource in JSON format, described by the following JSON schema:

  ```json
  {
    "type" : "object",
    "properties" : {
      "secretId" : {
        "title" : "Secret Label",
        "description" : "The secret label that is to be associated with a Secret Manager secret.",
        "propertyOrder" : 100,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "aliases" : {
        "title" : "aliases",
        "description" : "",
        "propertyOrder" : 200,
        "required" : true,
        "items" : {
          "type" : "string",
          "minLength" : 1
        },
        "minItems" : 1,
        "uniqueItems" : true,
        "type" : "array",
        "exampleValue" : ""
      }
    }
  }
  ```