GET api/UserGroups/Search?pageNumber={pageNumber}&itemsPerPage={itemsPerPage}&query={query}&restrictedAccess={restrictedAccess}&includeSystemGroups={includeSystemGroups}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
pageNumber | integer |
Default value is 1 |
|
itemsPerPage | integer |
Default value is 50 |
|
query | string |
None. |
|
restrictedAccess | boolean |
Default value is False |
|
includeSystemGroups | boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
PaginatedResultsOfPermissionGroupName | Description | Type | Additional information |
---|---|---|---|
TotalPages | integer |
None. |
|
CurrentPage | integer |
None. |
|
Results | Collection of PermissionGroup |
None. |
|
Count | integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "TotalPages": 1, "CurrentPage": 2, "Results": [ { "Claims": [ { "ClaimType": "sample string 1", "ClaimValue": "sample string 2", "ClaimTypeLower": "sample string 1", "ClaimValueLower": "sample string 2" }, { "ClaimType": "sample string 1", "ClaimValue": "sample string 2", "ClaimTypeLower": "sample string 1", "ClaimValueLower": "sample string 2" } ], "InstitutionIdentity": "1dc619e6-98b7-4801-b13e-0de0080643bb", "IsSystemGroup": true, "IsAdminGroup": true, "Scopes": [ 0, 0 ], "EditClaimsPermissionGroups": [ { "PermissionClaim": { "ClaimType": "sample string 1", "ClaimValue": "sample string 2", "ClaimTypeLower": "sample string 1", "ClaimValueLower": "sample string 2" }, "Identity": "5da6e8fd-3a44-4acb-abb5-e8b485b6b1ea", "Name": "sample string 2" }, { "PermissionClaim": { "ClaimType": "sample string 1", "ClaimValue": "sample string 2", "ClaimTypeLower": "sample string 1", "ClaimValueLower": "sample string 2" }, "Identity": "5da6e8fd-3a44-4acb-abb5-e8b485b6b1ea", "Name": "sample string 2" } ], "CanEditClaims": true, "Identity": "eab7265c-f803-4d76-bc07-c82079180fd4", "Name": "sample string 6" }, { "Claims": [ { "ClaimType": "sample string 1", "ClaimValue": "sample string 2", "ClaimTypeLower": "sample string 1", "ClaimValueLower": "sample string 2" }, { "ClaimType": "sample string 1", "ClaimValue": "sample string 2", "ClaimTypeLower": "sample string 1", "ClaimValueLower": "sample string 2" } ], "InstitutionIdentity": "1dc619e6-98b7-4801-b13e-0de0080643bb", "IsSystemGroup": true, "IsAdminGroup": true, "Scopes": [ 0, 0 ], "EditClaimsPermissionGroups": [ { "PermissionClaim": { "ClaimType": "sample string 1", "ClaimValue": "sample string 2", "ClaimTypeLower": "sample string 1", "ClaimValueLower": "sample string 2" }, "Identity": "5da6e8fd-3a44-4acb-abb5-e8b485b6b1ea", "Name": "sample string 2" }, { "PermissionClaim": { "ClaimType": "sample string 1", "ClaimValue": "sample string 2", "ClaimTypeLower": "sample string 1", "ClaimValueLower": "sample string 2" }, "Identity": "5da6e8fd-3a44-4acb-abb5-e8b485b6b1ea", "Name": "sample string 2" } ], "CanEditClaims": true, "Identity": "eab7265c-f803-4d76-bc07-c82079180fd4", "Name": "sample string 6" } ], "Count": 3 }
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.