Describe Groups

workdocs_describe_groups

R Documentation

Describes the groups specified by the query¶

Describes the groups specified by the query. Groups are defined by the underlying Active Directory.

workdocs_describe_groups(AuthenticationToken, SearchQuery,
  OrganizationId, Marker, Limit)

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

SearchQuery

[required] A query to describe groups by group name.

OrganizationId

The ID of the organization.

Marker

The marker for the next set of results. (You received this marker from a previous call.)

Limit

The maximum number of items to return with this call.

A list with the following syntax:

list(
  Groups = list(
    list(
      Id = "string",
      Name = "string"
    )
  ),
  Marker = "string"
)

svc$describe_groups(
  AuthenticationToken = "string",
  SearchQuery = "string",
  OrganizationId = "string",
  Marker = "string",
  Limit = 123
)