{ "opencollection": "1.0.0", "info": { "name": "Webex Admin Address Book Groups API", "version": "1.0.0" }, "items": [ { "info": { "name": "Groups", "type": "folder" }, "items": [ { "info": { "name": "List and Search Groups", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/groups", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "List groups in this organization. Only admin users of another organization (such as partners) may use this parameter." }, { "name": "filter", "value": "displayName eq \"Marketing Department\"", "type": "query", "description": "Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results." }, { "name": "attributes", "value": "displayName", "type": "query", "description": "The attributes to return." }, { "name": "sortBy", "value": "displayName", "type": "query", "description": "Sort the results based by group `displayName`." }, { "name": "sortOrder", "value": "ascending", "type": "query", "description": "Sort results alphabetically by group display name, in ascending or descending order." }, { "name": "includeMembers", "value": "false", "type": "query", "description": "Optionally return group members in the response. The maximum number of members returned is 500." }, { "name": "startIndex", "value": "1", "type": "query", "description": "The index to start for group pagination." }, { "name": "count", "value": "100", "type": "query", "description": "Specifies the desired number of search results per page." } ] }, "docs": "List groups in your organization.\n\n* Set the `includeMembers` parameter to `true` to return group members. The total number of members returned is limited to 500.\n\n* Use the `startIndex` and `count` parameters to page through result set.\n\n* To search for a specific group use the `filter` parameter.\n\n* Use `sortBy` parameter to sort the responses by `id` or `displayName`." }, { "info": { "name": "Create a Group", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/groups", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new group for a given organization. The group may optionally be created with group members." }, { "info": { "name": "Get Group Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/groups/:groupId", "params": [ { "name": "groupId", "value": "Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvYzY1ZjdkODUtYjY5MS00MmI4LWEyMGItODUzMDY0ZTFkNThiOjM0OGFkYjgxLTI4ZjktNGFiNS1iMmQ2LWU5YjQ5NGU3MmEwNg", "type": "path", "description": "A unique identifier for the group." }, { "name": "includeMembers", "value": "true", "type": "query", "description": "Include the members as part of the response." } ] }, "docs": "Get details for a group, by ID.\n\nOptionally, the members may be retrieved with this request. The maximum number of members returned is 500." }, { "info": { "name": "Update a Group", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/groups/:groupId", "params": [ { "name": "groupId", "value": "Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvYzY1ZjdkODUtYjY5MS00MmI4LWEyMGItODUzMDY0ZTFkNThiOjM0OGFkYjgxLTI4ZjktNGFiNS1iMmQ2LWU5YjQ5NGU3MmEwNg", "type": "path", "description": "A unique identifier for the group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the group details, by ID.\n\nSpecify the group ID in the `groupId` parameter in the URI." }, { "info": { "name": "Delete a Group", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/groups/:groupId", "params": [ { "name": "groupId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY", "type": "path", "description": "A unique identifier for the group." } ] }, "docs": "Remove a group from the system.\n\nSpecify the group ID in the `groupId` parameter in the URI." }, { "info": { "name": "Get Group Members", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/groups/:groupId/members", "params": [ { "name": "groupId", "value": "Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvYzY1ZjdkODUtYjY5MS00MmI4LWEyMGItODUzMDY0ZTFkNThiOjM0OGFkYjgxLTI4ZjktNGFiNS1iMmQ2LWU5YjQ5NGU3MmEwNg", "type": "path", "description": "A unique identifier for the group." }, { "name": "startIndex", "value": "1", "type": "query", "description": "The index to start for group pagination." }, { "name": "count", "value": "100", "type": "query", "description": "Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500." } ] }, "docs": "Gets the members of a group.\n\n* The default maximum members returned is 500.\n\n* Control parameters is available to page through the members and to control the size of the results." } ] } ], "bundled": true }