Class: Google::Apis::CloudidentityV1::EntityKey

Inherits:

Object

• Object
• Google::Apis::CloudidentityV1::EntityKey

Includes:

Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport

Defined in:

lib/google/apis/cloudidentity_v1/classes.rb,
lib/google/apis/cloudidentity_v1/representations.rb,
lib/google/apis/cloudidentity_v1/representations.rb

Overview

A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional namespace or a user without a namespace. The combination of id and namespace must be unique; however, the same id can be used with different namespaces.

Instance Attribute Summary

• #id ⇒ String

  The ID of the entity.

• #namespace ⇒ String

  The namespace in which the entity exists.

Instance Method Summary

• #initialize(**args) ⇒ EntityKey constructor

  A new instance of EntityKey.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ EntityKey

Returns a new instance of EntityKey.

# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 363

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#id ⇒ String

The ID of the entity. For Google-managed entities, the id should be the email address of an existing group or user. Email addresses need to adhere to name guidelines for users and groups. For external-identity-mapped entities, the id must be a string conforming to the Identity Source's requirements. Must be unique within a namespace. Corresponds to the JSON property id

Returns:

• (String)

# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 352

def id
  @id
end

#namespace ⇒ String

The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of identitysources/identity_source`. Corresponds to the JSON propertynamespace`

Returns:

• (String)

# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 361

def namespace
  @namespace
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 368

def update!(**args)
  @id = args[:id] if args.key?(:id)
  @namespace = args[:namespace] if args.key?(:namespace)
end