Class: Google::Apps::Chat::V1::CreateMembershipRequest

Inherits:

Object

• Object
• Google::Apps::Chat::V1::CreateMembershipRequest

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/chat/v1/membership.rb

Overview

Request message for creating a membership.

Instance Attribute Summary

• #membership ⇒ ::Google::Apps::Chat::V1::Membership

  Required.

• #parent ⇒ ::String

  Required.

• #use_admin_access ⇒ ::Boolean

  Optional.

Instance Attribute Details

#membership ⇒ ::Google::Apps::Chat::V1::Membership

Returns Required. The membership relation to create.

The memberType field must contain a user with the user.name and user.type fields populated. The server will assign a resource name and overwrite anything specified.

When a Chat app creates a membership relation for a human user, it must use certain authorization scopes and set specific values for certain fields:

• When authenticating as a user, the chat.memberships authorization scope is required.

• When authenticating as an app, the chat.app.memberships authorization scope is required. Authenticating as an app is available in Developer Preview.

• Set user.type to HUMAN, and set user.name with format users/{user}, where {user} can be the email address for the user. For users in the same Workspace organization {user} can also be the id of the person from the People API, or the id for the user in the Directory API. For example, if the People API Person profile ID for user@example.com is 123456789, you can add the user to the space by setting the membership.member.name to users/user@example.com or users/123456789.

Inviting users external to the Workspace organization that owns the space requires user authentication.

When a Chat app creates a membership relation for itself, it must authenticate as a user and use the chat.memberships.app scope, set user.type to BOT, and set user.name to users/app.

Returns:

• (::Google::Apps::Chat::V1::Membership) —

  Required. The membership relation to create.

  The memberType field must contain a user with the user.name and user.type fields populated. The server will assign a resource name and overwrite anything specified.

  When a Chat app creates a membership relation for a human user, it must use certain authorization scopes and set specific values for certain fields:

  • When authenticating as a user, the chat.memberships authorization scope is required.

  • When authenticating as an app, the chat.app.memberships authorization scope is required. Authenticating as an app is available in Developer Preview.

  • Set user.type to HUMAN, and set user.name with format users/{user}, where {user} can be the email address for the user. For users in the same Workspace organization {user} can also be the id of the person from the People API, or the id for the user in the Directory API. For example, if the People API Person profile ID for user@example.com is 123456789, you can add the user to the space by setting the membership.member.name to users/user@example.com or users/123456789.

  Inviting users external to the Workspace organization that owns the space requires user authentication.

  When a Chat app creates a membership relation for itself, it must authenticate as a user and use the chat.memberships.app scope, set user.type to BOT, and set user.name to users/app.

# File 'proto_docs/google/chat/v1/membership.rb', line 168

class CreateMembershipRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

Returns Required. The resource name of the space for which to create the membership.

Format: spaces/{space}.

Returns:

• (::String) —

  Required. The resource name of the space for which to create the membership.

  Format: spaces/{space}

# File 'proto_docs/google/chat/v1/membership.rb', line 168

class CreateMembershipRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#use_admin_access ⇒ ::Boolean

Returns Optional. When true, the method runs using the user's Google Workspace administrator privileges.

The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege.

Requires the chat.admin.memberships OAuth 2.0 scope.

Creating app memberships or creating memberships for users outside the administrator's Google Workspace organization isn't supported using admin access.

Returns:

• (::Boolean) —

  Optional. When true, the method runs using the user's Google Workspace administrator privileges.

  The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege.

  Requires the chat.admin.memberships OAuth 2.0 scope.

  Creating app memberships or creating memberships for users outside the administrator's Google Workspace organization isn't supported using admin access.

# File 'proto_docs/google/chat/v1/membership.rb', line 168

class CreateMembershipRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end