Group Members

patch

https://app.financekey.com/OData/GroupMembers({key})

The GroupMember table serves to establish and manage the association between users and their respective groups within the Group package. Each entry in this table represents a unique membership instance, containing fields that specify the group ID, member ID, role or permissions assigned to the member within the group, and timestamps for membership creation and updates. This table facilitates collaborative interactions and access control settings, ensuring that members can engage in group activities and share resources effectively while maintaining clear records of member roles and status within various groups.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

key

string

required

Body Params

displayName

string

required

length between 1 and 256

The DisplayName field is an nvarchar data type designed to store the display name of a group member. It allows for a maximum length of 256 characters, accommodating a wide range of name formats and ensuring clarity and distinctiveness in group identification. This field is essential for user-friendly representation in user interfaces and reports.

mail

string | null

The 'Mail' field in the 'GroupMember' table is designed to store the email addresses of group members. It is of data type 'nvarchar,' allowing for the inclusion of Unicode characters and supporting a wide range of email formats. The field accommodates a maximum length of up to 255 characters, ensuring flexibility in capturing various email address conventions while maintaining integrity for valid email formats. This field is essential for communication and notifications within the group context.

mailEnabled

boolean

The MailEnabled field indicates whether a group member is enabled to send and receive email. It is represented as a bit value, where '1' signifies that the member has email capabilities and '0' indicates that the member does not have email functionality.

mailNickname

string

required

length between 1 and 128

MailNickname: A unique identifier for the group member, used primarily for email aliases. This field supports a maximum length of 128 characters and is stored as an nvarchar data type, allowing for the inclusion of Unicode characters. The MailNickname should be concise and user-friendly to facilitate easy reference in email communication.

securityEnabled

boolean

The SecurityEnabled field is a binary indicator that specifies whether the group member has security privileges. A value of '1' (true) indicates that the member possesses security-related capabilities, while a value of '0' (false) indicates the absence of such privileges. This field is essential for managing access control and security roles within the system.

jobTitle

string | null

JobTitle: A field that stores the job title of a group member, represented as a string with variable length. This field utilizes the NVARCHAR data type to accommodate a diverse range of characters, including those from different languages, allowing for up to 255 characters in length. The JobTitle field is designed to capture the official title or designation held by the member within the organization or group, facilitating role identification and organizational structuring.

userPrincipalName

string

required

length ≥ 1

UserPrincipalName (nvarchar): A unique identifier for a user in the format of an email address, typically used for authentication and authorization purposes within a directory service or cloud-based system. This field stores the principal name associated with a user, allowing for easy identification and management of user accounts within the GroupMember table.

groupId

uuid

required

GroupId: A unique identifier (UUID) that represents the specific group to which a member belongs in the GroupMember table. This field ensures that each group can be distinctly identified and associated with its corresponding members, maintaining referential integrity within the database.

groupMemberId

uuid

required

The GroupMemberId field is a primary key in the GroupMember table, designated as a uniqueidentifier data type. It serves as a unique identifier for each record in the table, ensuring that each group member can be distinctly recognized. This field is used to maintain the integrity of the data by preventing duplicate entries and facilitating efficient retrieval of group member information.

Headers

content-type

string

enum

Defaults to application/json;odata.metadata=minimal;odata.streaming=true

Generated from available request content types

Response

200

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here!