REST Resource: projects.locations.workloadIdentityPools.namespaces

Resource: WorkloadIdentityPoolNamespace

Represents a namespace for a workload identity pool. Namespaces are used to segment identities within the pool.

JSON representation
{
  "name": string,
  "description": string,
  "state": enum (State),
  "disabled": boolean,
  "expireTime": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "ownerService": {
    object (OwnerService)
  }
  // End of mutually exclusive fields.
}
Fields
name

string

Identifier. The resource name of the namespace.

description

string

Optional. A description of the namespace. Cannot exceed 256 characters.

state

enum (State)

Output only. The state of the namespace.

disabled

boolean

Optional. Whether the namespace is disabled. If disabled, credentials may no longer be issued for identities within this namespace, however existing credentials will still be accepted until they expire.

expireTime

string (Timestamp format)

Output only. Time after which the namespace will be permanently purged and cannot be recovered.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

Defines the owner that is allowed to mutate this resource. If present, this resource can only be mutated by the owner. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
ownerService

object (OwnerService)

Output only. The Google Cloud service that owns this namespace.

End of mutually exclusive fields.

State

The current state of the namespace.

Enums
STATE_UNSPECIFIED State unspecified.
ACTIVE The namespace is active.
DELETED

The namespace is soft-deleted. Soft-deleted namespaces are permanently deleted after approximately 30 days. You can restore a soft-deleted namespace using namespaces.undelete.

You cannot reuse the ID of a soft-deleted namespace until it is permanently deleted.

OwnerService

The Google Cloud service that owns this namespace.

JSON representation
{
  "principalSubject": string
}
Fields
principalSubject

string

Required. The service agent principal subject, e.g. "serviceAccount:service-1234@gcp-sa-gkehub.iam.gserviceaccount.com".

Methods

create

Creates a new WorkloadIdentityPoolNamespace in a WorkloadIdentityPool.

delete

Deletes a WorkloadIdentityPoolNamespace.

get

Gets an individual WorkloadIdentityPoolNamespace.

list

Lists all non-deleted WorkloadIdentityPoolNamespaces in a workload identity pool.

patch

Updates an existing WorkloadIdentityPoolNamespace in a WorkloadIdentityPool.

undelete

Undeletes a WorkloadIdentityPoolNamespace, as long as it was deleted fewer than 30 days ago.