MSGraphAPI.Users.Group

Users.Group

A Group is an AAD group, which can be a Microsoft 365 group, or a security group.

A team in Microsoft Teams is a collection of channel objects. A channel represents a topic, and therefore a logical isolation of discussion, within a team.

Every team is associated with a Microsoft 365 group. The group has the same ID as the team - for example, /groups/{id}/team is the same as /teams/{id}.

Teams

Joined teams

listUserJoinedTeams

Arguments

:: Text

User ID

-> AccessToken

-> Req (Collection Group)

Get the teams in Microsoft Teams that the given user is a direct member of.

GET /users/{id | user-principal-name}/joinedTeams

https://learn.microsoft.com/en-us/graph/api/user-list-joinedteams?view=graph-rest-1.0&tabs=http

listMeJoinedTeams :: AccessToken -> Req (Collection Group)

Get the teams in Microsoft Teams that the current user is a direct member of.

GET /me/joinedTeams

https://learn.microsoft.com/en-us/graph/api/user-list-joinedteams?view=graph-rest-1.0&tabs=http

Associated teams

listUserAssociatedTeams

Arguments

:: Text

User ID

-> AccessToken

-> Req (Collection Group)

Get the list of teams in Microsoft Teams that a user is associated with.

GET /users/{user-id}/teamwork/associatedTeams

Currently, a user can be associated with a team in two different ways:

• A user can be a direct member of a team.
• A user can be a member of a shared channel that is hosted inside a team.

listMeAssociatedTeams :: AccessToken -> Req (Collection Group)

Get the teams in Microsoft Teams that the current user is associated with (see getUserAssociatedTeams).

Team channels

listTeamChannels

Arguments

:: Text

team ID

-> AccessToken

-> Req (Collection Channel)

Get the list of channels either in this team or shared with this team (incoming channels).

GET /teams/{team-id}/allChannels

Channel messages

listChannelMessages

Arguments

:: Text

team ID

-> Text

channel ID

-> AccessToken

-> Req (Collection ChatMessage)

Retrieve the list of messages (without the replies) in a channel of a team.

To get the replies for a message, call the listMessageReplies or the get message reply API.

GET /teams/{team-id}/channels/{channel-id}/messages

getChannelMessage

Arguments

:: Text

team ID

-> Text

channel ID

-> Text

message ID

-> AccessToken

-> Req ChatMessage

Retrieve a single message or a message reply in a channel or a chat.

GET /teams/{team-id}/channels/{channel-id}/messages/{message-id}

listMessageReplies

Arguments

:: Text

team ID

-> Text

channel ID

-> Text

message ID

-> AccessToken

-> Req (Collection ChatMessage)

List all the replies to a message in a channel of a team.

This method lists only the replies of the specified message, if any. To get the message itself, use getChannelMessage.

GET teams{team-id}channels{channel-id}messages{message-id}/replies

Drive items

listGroupsDriveItems

Arguments

:: Text

Group ID

-> AccessToken

-> Req (Collection DriveItem)

Get the DriveItems in the Group storage, starting from the root item

GET /groups/{group-id}/drive/root/children

https://learn.microsoft.com/en-us/graph/api/driveitem-list-children?view=graph-rest-1.0&tabs=http

NB : requires Files.Read.All, since it tries to access all files a user has access to.

types

data Group

Groups are collections of principals with shared access to resources in Microsoft services or in your app. Different principals such as users, other groups, devices, and applications can be part of groups.

https://learn.microsoft.com/en-us/graph/api/resources/groups-overview?view=graph-rest-1.0&tabs=http

Constructors

Group

Fields

• gId :: Text
• gDisplayName :: Text
• gDescription :: Text

Instances

FromJSON Group

Defined in MSGraphAPI.Users.Group

Methods

parseJSON :: Value -> Parser Group

parseJSONList :: Value -> Parser [Group]

ToJSON Group

Defined in MSGraphAPI.Users.Group

Methods

toJSON :: Group -> Value

toEncoding :: Group -> Encoding

toJSONList :: [Group] -> Value

toEncodingList :: [Group] -> Encoding

Generic Group

Defined in MSGraphAPI.Users.Group

Associated Types

type Rep Group :: Type -> Type

Methods

from :: Group -> Rep Group x

to :: Rep Group x -> Group

Show Group

Defined in MSGraphAPI.Users.Group

Methods

showsPrec :: Int -> Group -> ShowS

show :: Group -> String

showList :: [Group] -> ShowS

Eq Group

Defined in MSGraphAPI.Users.Group

Methods

(==) :: Group -> Group -> Bool

(/=) :: Group -> Group -> Bool

Ord Group

Defined in MSGraphAPI.Users.Group

Methods

compare :: Group -> Group -> Ordering

(<) :: Group -> Group -> Bool

(<=) :: Group -> Group -> Bool

(>) :: Group -> Group -> Bool

(>=) :: Group -> Group -> Bool

max :: Group -> Group -> Group

min :: Group -> Group -> Group

type Rep Group

Defined in MSGraphAPI.Users.Group

type Rep Group = D1 ('MetaData "Group" "MSGraphAPI.Users.Group" "ms-graph-api-0.11.0.0-5uHIC7CmGj38m31PNkaDsF" 'False) (C1 ('MetaCons "Group" 'PrefixI 'True) (S1 ('MetaSel ('Just "gId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "gDisplayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "gDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

data Channel

Teams are made up of channels, which are the conversations you have with your teammates. Each channel is dedicated to a specific topic, department, or project. Channels are where the work actually gets done - where text, audio, and video conversations open to the whole team happen, where files are shared, and where tabs are added.

https://learn.microsoft.com/en-us/graph/api/resources/channel?view=graph-rest-1.0

Constructors

Channel

Fields

• chId :: Text
• chDisplayName :: Text
• chDescription :: Text

Instances

FromJSON Channel

Defined in MSGraphAPI.Users.Group

Methods

parseJSON :: Value -> Parser Channel

parseJSONList :: Value -> Parser [Channel]

ToJSON Channel

Defined in MSGraphAPI.Users.Group

Methods

toJSON :: Channel -> Value

toEncoding :: Channel -> Encoding

toJSONList :: [Channel] -> Value

toEncodingList :: [Channel] -> Encoding

Generic Channel

Defined in MSGraphAPI.Users.Group

Associated Types

type Rep Channel :: Type -> Type

Methods

from :: Channel -> Rep Channel x

to :: Rep Channel x -> Channel

Show Channel

Defined in MSGraphAPI.Users.Group

Methods

showsPrec :: Int -> Channel -> ShowS

show :: Channel -> String

showList :: [Channel] -> ShowS

Eq Channel

Defined in MSGraphAPI.Users.Group

Methods

(==) :: Channel -> Channel -> Bool

(/=) :: Channel -> Channel -> Bool

Ord Channel

Defined in MSGraphAPI.Users.Group

Methods

compare :: Channel -> Channel -> Ordering

(<) :: Channel -> Channel -> Bool

(<=) :: Channel -> Channel -> Bool

(>) :: Channel -> Channel -> Bool

(>=) :: Channel -> Channel -> Bool

max :: Channel -> Channel -> Channel

min :: Channel -> Channel -> Channel

type Rep Channel

Defined in MSGraphAPI.Users.Group

type Rep Channel = D1 ('MetaData "Channel" "MSGraphAPI.Users.Group" "ms-graph-api-0.11.0.0-5uHIC7CmGj38m31PNkaDsF" 'False) (C1 ('MetaCons "Channel" 'PrefixI 'True) (S1 ('MetaSel ('Just "chId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "chDisplayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "chDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

Chat messages

data ChatMessage

An individual chat message within a channel or chat. The message can be a root message or part of a thread

https://learn.microsoft.com/en-us/graph/api/resources/chatmessage?view=graph-rest-1.0

Constructors

ChatMessage

Fields

• chamBody :: ChatMessageBody
• chamId :: Text
• chamCreatedDateTime :: ZonedTime
• chamDeletedDateTime :: Maybe ZonedTime

Instances

FromJSON ChatMessage

Defined in MSGraphAPI.Users.Group

Methods

parseJSON :: Value -> Parser ChatMessage

parseJSONList :: Value -> Parser [ChatMessage]

ToJSON ChatMessage

Defined in MSGraphAPI.Users.Group

Methods

toJSON :: ChatMessage -> Value

toEncoding :: ChatMessage -> Encoding

toJSONList :: [ChatMessage] -> Value

toEncodingList :: [ChatMessage] -> Encoding

Generic ChatMessage

Defined in MSGraphAPI.Users.Group

Associated Types

type Rep ChatMessage :: Type -> Type

Methods

from :: ChatMessage -> Rep ChatMessage x

to :: Rep ChatMessage x -> ChatMessage

Show ChatMessage

Defined in MSGraphAPI.Users.Group

Methods

showsPrec :: Int -> ChatMessage -> ShowS

show :: ChatMessage -> String

showList :: [ChatMessage] -> ShowS

type Rep ChatMessage

Defined in MSGraphAPI.Users.Group

type Rep ChatMessage = D1 ('MetaData "ChatMessage" "MSGraphAPI.Users.Group" "ms-graph-api-0.11.0.0-5uHIC7CmGj38m31PNkaDsF" 'False) (C1 ('MetaCons "ChatMessage" 'PrefixI 'True) ((S1 ('MetaSel ('Just "chamBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChatMessageBody) :*: S1 ('MetaSel ('Just "chamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "chamCreatedDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ZonedTime) :*: S1 ('MetaSel ('Just "chamDeletedDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ZonedTime)))))

data ChatMessageBody

Constructors

ChatMessageBody

Fields

• chambId :: Text

Instances

FromJSON ChatMessageBody

Defined in MSGraphAPI.Users.Group

Methods

parseJSON :: Value -> Parser ChatMessageBody

parseJSONList :: Value -> Parser [ChatMessageBody]

ToJSON ChatMessageBody

Defined in MSGraphAPI.Users.Group

Methods

toJSON :: ChatMessageBody -> Value

toEncoding :: ChatMessageBody -> Encoding

toJSONList :: [ChatMessageBody] -> Value

toEncodingList :: [ChatMessageBody] -> Encoding

Generic ChatMessageBody

Defined in MSGraphAPI.Users.Group

Associated Types

type Rep ChatMessageBody :: Type -> Type

Methods

from :: ChatMessageBody -> Rep ChatMessageBody x

to :: Rep ChatMessageBody x -> ChatMessageBody

Show ChatMessageBody

Defined in MSGraphAPI.Users.Group

Methods

showsPrec :: Int -> ChatMessageBody -> ShowS

show :: ChatMessageBody -> String

showList :: [ChatMessageBody] -> ShowS

Eq ChatMessageBody

Defined in MSGraphAPI.Users.Group

Methods

(==) :: ChatMessageBody -> ChatMessageBody -> Bool

(/=) :: ChatMessageBody -> ChatMessageBody -> Bool

Ord ChatMessageBody

Defined in MSGraphAPI.Users.Group

Methods

compare :: ChatMessageBody -> ChatMessageBody -> Ordering

(<) :: ChatMessageBody -> ChatMessageBody -> Bool

(<=) :: ChatMessageBody -> ChatMessageBody -> Bool

(>) :: ChatMessageBody -> ChatMessageBody -> Bool

(>=) :: ChatMessageBody -> ChatMessageBody -> Bool

max :: ChatMessageBody -> ChatMessageBody -> ChatMessageBody

min :: ChatMessageBody -> ChatMessageBody -> ChatMessageBody

type Rep ChatMessageBody

Defined in MSGraphAPI.Users.Group

type Rep ChatMessageBody = D1 ('MetaData "ChatMessageBody" "MSGraphAPI.Users.Group" "ms-graph-api-0.11.0.0-5uHIC7CmGj38m31PNkaDsF" 'False) (C1 ('MetaCons "ChatMessageBody" 'PrefixI 'True) (S1 ('MetaSel ('Just "chambId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))