Gcp/apikeys
@swamp/gcp/apikeysv2026.07.28.1
01README
Google Cloud apikeys infrastructure models
02Release Notes
- Updated: keys
03Models
@swamp/gcp/apikeys/keysv2026.07.28.1keys.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| annotations? | record | Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. |
| displayName? | string | Human-readable display name of this key that you can modify. The maximum length is 63 characters. |
| name? | string | Identifier. The resource name of the key. The `name` has the form: `projects//locations/global/keys/`. For example: `projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2` NOTE: Key is a global resource; hence the only supported value for location is `global`. |
| restrictions? | object | Key restrictions. |
| serviceAccountEmail? | string | Optional. The email address of [the service account](https://cloud.google.com/iam/docs/service-accounts) the key is bound to. |
| keyId? | string | User specified key id (optional). If specified, it will become the final component of the key resource name. The id must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. In another word, the id must match the regular expression: `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`. The id must NOT be a UUID-like string. |
| location? | string | The location for this resource (this resource only supports 'global') |
fn create()
Create a keys
fn get(identifier: string)
Get a keys
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the keys |
fn update(identifier?: string)
Update keys attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific keys by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the keys
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the keys |
fn sync(identifier?: string)
Sync keys state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific keys by name (e.g. one discovered by list) |
fn list(pageSize?: number, showDeleted?: boolean, maxPages?: number)
List keys resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. Specifies the maximum number of results to be returned at a time. |
| showDeleted? | boolean | Optional. Indicate that keys deleted in the past 30 days should also be returned. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn get_key_string()
get key string
fn undelete()
undelete
Resources
state(infinite)— The representation of a key managed by the API Keys API.
04Previous Versions
2026.07.21.3
- Updated: keys
2026.07.21.1
- Updated: keys
2026.07.20.1
- Updated: keys
2026.07.19.1
- Updated: keys
2026.07.18.2
- Updated: keys
2026.07.17.2
- Updated: keys
2026.07.17.1
- Updated: keys
2026.06.08.2
- Updated: keys
2026.06.07.1
- Updated: keys
2026.05.25.1
- Updated: keys
Modified 1 models
2026.05.24.1
- Updated: keys
2026.05.21.2
- Updated: keys
2026.05.21.1
2026.05.19.2
2026.05.19.1
2026.05.18.1
2026.04.23.1
2026.04.03.3
- Updated: keys
2026.04.03.1
- Updated: keys
05Stats
A
100 / 100
Downloads
0
Archive size
27.7 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels