Method GetAllGroups

GetAllGroups(String, Boolean)

Get all groups information of this server

Declaration

GroupResultContract GetAllGroups(string connectionId, bool withDeactivatedAndDeletedUsers)

Parameters

Type	Name	Description
System.String	connectionId	The connection id to identify your connection. See also ConnectionId
System.Boolean	withDeactivatedAndDeletedUsers	Defines with deactivated and deleted users returned

Returns

Type	Description
GroupResultContract	Get all groups

Examples

POST http://YourServerName/InfoShare/Json/Common/GetAllGroups

Example for get all groups information of this server.

{
   "connectionId": "b6742bb8-ef97-44ae-819b-a2fa2200908a",
   "withDeactivatedAndDeletedUsers": false
}

Response:

{
    "GetAllGroupsResult": {
        "Groups": [
        {
            "Description": {
                "Values": [{
                    "Culture": "de",
                    "Text": "Administration" 
                    },
                    {
                    "Culture": "en",
                    "Text": "Administration"
                    }]
            },
            "DisplayName": "Administration",
            "Domain": "",
            "Id": "2069f7e6-fe3e-ed11-8d62-00155d290a68",
            "Name": "Administration",
            "UserIds": [ "0100a003-38a7-11d8-a902-0050bf427e8f","2e784cd9-fe3e-ed11-8d62-00155d290a68","7e417df3-fe3e-ed11-8d62-00155d290a68","09a7322e-814f-ed11-8d74-00155d290a68"],
            "SID": "S-1-5-21-515967899-920026266-1708537768-1000"
        },
        {
            "Description": {
                "Values": [{
                    "Culture": "de",
                    "Text": "testGroup"
                    },
                    {
                    "Culture": "en",
                    "Text": "testGroup"
                    }]
        },
            "DisplayName": "testGroup",
            "Domain": "",
            "Id": "91444750-80bd-ed11-8dda-00155d290a68",
            "Name": "testGroup",
            "UserIds": ["0100a003-38a7-11d8-a902-0050bf427e8f","7e417df3-fe3e-ed11-8d62-00155d290a68"],
            "SID": "S-1-5-21-515967899-920026266-1708537768-1000"
        }],
        "SessionCount": 83
        }
}

Exceptions

Type	Condition
ServiceException	The connection id {connectionId} isn't valid or has expired (10008)
ServiceException	Verification code is needed: Verification code not yet verified (10152)
ServiceException	Two way authentication type ({twoWayAuthenticationType}) is invalid. Valid types are: {allowedTwoWayAuthenticationTypes} (10148)
ServiceException	Could not parse int {flag} to a valid two way authentication type (10154)