Class CreateMembershipRequest
Request message for creating a membership.
Implements
Namespace: Google.Apps.Chat.V1
Assembly: Google.Apps.Chat.V1.dll
Syntax
public sealed class CreateMembershipRequest : IMessage<CreateMembershipRequest>, IEquatable<CreateMembershipRequest>, IDeepCloneable<CreateMembershipRequest>, IBufferMessage, IMessage
Constructors
CreateMembershipRequest()
Declaration
public CreateMembershipRequest()
CreateMembershipRequest(CreateMembershipRequest)
Declaration
public CreateMembershipRequest(CreateMembershipRequest other)
Parameters
Type | Name | Description |
---|---|---|
CreateMembershipRequest | other |
Properties
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
the chat.memberships
scope, 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
. When a Chat app creates a
membership relation for itself, it must use the chat.memberships.app
scope, set user.type
to BOT
, and set user.name
to users/app
.
Declaration
public Membership Membership { get; set; }
Property Value
Type | Description |
---|---|
Membership |
Parent
Required. The resource name of the space for which to create the membership.
Format: spaces/{space}
Declaration
public string Parent { get; set; }
Property Value
Type | Description |
---|---|
string |
ParentAsSpaceName
Declaration
public SpaceName ParentAsSpaceName { get; set; }
Property Value
Type | Description |
---|---|
SpaceName |
UseAdminAccess
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.
Declaration
public bool UseAdminAccess { get; set; }
Property Value
Type | Description |
---|---|
bool |