GroupsApi

All URIs are relative to http://localhost

Method	HTTP request	Description
groupsDiscoverAvailableGroups	GET /{tenantId}/directory/{directoryId}/groups/discover	Retrieves a list of Nested Public Groups for the targeted Tenant. These Groups can be joined if the current user has a UserProfile in the targeted Tenant.
groupsFindGroups	POST /{tenantId}/directory/{directoryId}/groups/find	Finds groups that match the query conditions.
groupsGetGroupMembership	POST /{tenantId}/directory/{directoryId}/groups/{groupId}/members

groupsDiscoverAvailableGroups

GroupSummaryPagedApiResponse groupsDiscoverAvailableGroups(tenantId, directoryId)

Retrieves a list of Nested Public Groups for the targeted Tenant. These Groups can be joined if the current user has a UserProfile in the targeted Tenant.

Parameters

Name	Type	Description	Notes
tenantId	String		[default to null]
directoryId	String		[default to null]

Return type

GroupSummaryPagedApiResponse

Authorization

Oauth2Scheme, Oauth2Scheme, JwtBearerTokenScheme

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

groupsFindGroups

GroupSummaryPagedApiResponse groupsFindGroups(tenantId, directoryId, page, pageSize, FindGroupQuery)

Finds groups that match the query conditions.

Parameters

Name	Type	Description	Notes
tenantId	String		[default to null]
directoryId	String		[default to null]
page	Integer		[optional] [default to 1]
pageSize	Integer		[optional] [default to 25]
FindGroupQuery	FindGroupQuery		[optional]

Return type

GroupSummaryPagedApiResponse

Authorization

Oauth2Scheme, Oauth2Scheme, JwtBearerTokenScheme

HTTP request headers

• Content-Type: application/json-patch+json, application/json, text/json, application/*+json
• Accept: application/json

groupsGetGroupMembership

UserProfileSummaryPagedApiResponse groupsGetGroupMembership(tenantId, directoryId, groupId, chatEnabled, page, pageSize)

Parameters

Name	Type	Description	Notes
tenantId	String		[default to null]
directoryId	String		[default to null]
groupId	String		[default to null]
chatEnabled	Boolean		[optional] [default to false]
page	Integer		[optional] [default to 1]
pageSize	Integer		[optional] [default to 25]

Return type

UserProfileSummaryPagedApiResponse

Authorization

Oauth2Scheme, Oauth2Scheme, JwtBearerTokenScheme

HTTP request headers

• Content-Type: Not defined
• Accept: application/json