Returns a list of groups.

oc_list_groups(filter = "", sort = "", limit = 0, offset = 0)

Arguments

filter

A comma seperated list of filters to limit the results with. A filter is the filter's name followed by a colon ":" and then the value to filter with so it is the form :.

sort

Sort the results based upon a list of comma seperated sorting criteria. In the comma seperated list each type of sorting is specified as a pair such as: :ASC or :DESC. Adding the suffix ASC or DESC sets the order as ascending or descending order and is mandatory.

limit

The maximum number of results to return for a single request.

offset

The index of the first result to return.

Value

Returns a list of groups.

Details

This function expects the hostname, username and password to be set as environment variables.

Examples

Sys.setenv(OPENCAST_HOST = "https://legacy.opencast.org") Sys.setenv(OPENCAST_USERNAME = "admin") Sys.setenv(OPENCAST_PASSWORD = "opencast") oc_list_groups()
#> $content #> identifier #> 1 MH_DEFAULT_ORG_EXTERNAL_APPLICATIONS #> 2 MH_DEFAULT_ORG_SYSTEM_ADMINS #> role organization #> 1 ROLE_GROUP_MH_DEFAULT_ORG_EXTERNAL_APPLICATIONS mh_default_org #> 2 ROLE_GROUP_MH_DEFAULT_ORG_SYSTEM_ADMINS mh_default_org #> roles #> 1 ROLE_API_EVENTS_METADATA_VIEW,ROLE_API_SERIES_DELETE,ROLE_API_GROUPS_CREATE,ROLE_API_EVENTS_MEDIA_VIEW,ROLE_API_SERIES_VIEW,ROLE_API_SERIES_METADATA_VIEW,ROLE_API_WORKFLOW_INSTANCE_EDIT,ROLE_API_SERIES_METADATA_EDIT,ROLE_API_WORKFLOW_INSTANCE_DELETE,ROLE_API_SERIES_ACL_VIEW,ROLE_API_WORKFLOW_INSTANCE_VIEW,ROLE_API_EVENTS_CREATE,ROLE_API_SERIES_PROPERTIES_EDIT,ROLE_API_WORKFLOW_INSTANCE_CREATE,ROLE_API_SERIES_CREATE,ROLE_API_GROUPS_DELETE,ROLE_API_EVENTS_ACL_EDIT,ROLE_API_SERIES_EDIT,ROLE_API_EVENTS_METADATA_EDIT,ROLE_API_EVENTS_METADATA_DELETE,ROLE_API_EVENTS_ACL_DELETE,ROLE_API_EVENTS_VIEW,ROLE_API_GROUPS_VIEW,ROLE_API_EVENTS_SCHEDULING_EDIT,ROLE_API_EVENTS_DELETE,ROLE_API_SECURITY_EDIT,ROLE_API,ROLE_API_CAPTURE_AGENTS_VIEW,ROLE_API_SERIES_ACL_EDIT,ROLE_API_SERIES_PROPERTIES_VIEW,ROLE_API_EVENTS_PUBLICATIONS_VIEW,ROLE_API_EVENTS_SCHEDULING_VIEW,ROLE_SUDO,ROLE_API_SERIES_METADATA_DELETE,ROLE_API_WORKFLOW_DEFINITION_VIEW,ROLE_API_EVENTS_EDIT,ROLE_API_EVENTS_ACL_VIEW,ROLE_API_GROUPS_EDIT #> 2 ROLE_SUDO,ROLE_OAUTH_USER,ROLE_ADMIN,ROLE_ANONYMOUS #> members name #> 1 Opencast Project External Applications #> 2 admin Opencast Project System Administrators #> description #> 1 External application users of 'Opencast Project' #> 2 System administrators of 'Opencast Project' #> #> $url #> [1] "https://legacy.opencast.org/api/groups/" #> #> $response #> Response [https://legacy.opencast.org/api/groups/?filter=&sort=&limit=0&offset=0] #> Date: 2019-11-04 11:18 #> Status: 200 #> Content-Type: application/v1.2.0+json #> Size: 1.6 kB #> <BINARY BODY> #> #> attr(,"class") #> [1] "opencast_api"