PUT api/UserGroups/{id}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | string |
Required |
Body Parameters
PermissionGroup| Name | Description | Type | Additional information |
|---|---|---|---|
| Claims | Collection of PermissionClaim |
None. |
|
| InstitutionIdentity | globally unique identifier |
None. |
|
| IsSystemGroup | boolean |
None. |
|
| IsAdminGroup | boolean |
None. |
|
| Scopes | Collection of ScopeType |
None. |
|
| EditClaimsPermissionGroups | Collection of PermissionObject |
None. |
|
| CanEditClaims | boolean |
None. |
|
| Identity | globally unique identifier |
None. |
|
| Name | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"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": "4312a330-7884-4bed-93ec-e1d0b218027c",
"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": "f5fd9aeb-be1e-4f11-a372-a23ac8ddaa12",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "f5fd9aeb-be1e-4f11-a372-a23ac8ddaa12",
"Name": "sample string 2"
}
],
"CanEditClaims": true,
"Identity": "74fb0f26-fe2a-47d6-9bc4-cd1e8438a508",
"Name": "sample string 6"
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
PermissionGroup| Name | Description | Type | Additional information |
|---|---|---|---|
| Claims | Collection of PermissionClaim |
None. |
|
| InstitutionIdentity | globally unique identifier |
None. |
|
| IsSystemGroup | boolean |
None. |
|
| IsAdminGroup | boolean |
None. |
|
| Scopes | Collection of ScopeType |
None. |
|
| EditClaimsPermissionGroups | Collection of PermissionObject |
None. |
|
| CanEditClaims | boolean |
None. |
|
| Identity | globally unique identifier |
None. |
|
| Name | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"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": "8bfb27c4-40a7-457a-9974-039375a6c3ef",
"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": "de28ea7a-74a9-4ea3-bae6-8855746b961b",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "de28ea7a-74a9-4ea3-bae6-8855746b961b",
"Name": "sample string 2"
}
],
"CanEditClaims": true,
"Identity": "3675ae71-7118-4aca-ab6a-752c71f5e41b",
"Name": "sample string 6"
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.