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": "72e346bf-bd05-42ad-92b9-b287bce72b42",
"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": "27f4ca76-17fa-4a38-bebf-12dfc6c9849e",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "27f4ca76-17fa-4a38-bebf-12dfc6c9849e",
"Name": "sample string 2"
}
],
"CanEditClaims": true,
"Identity": "e1fd4db4-d096-423e-a335-e05efad33541",
"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": "d778dff4-d934-4ec2-8720-ac1c09ab794c",
"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": "1567f794-348c-4cd5-af21-1a795cdc1b3b",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "1567f794-348c-4cd5-af21-1a795cdc1b3b",
"Name": "sample string 2"
}
],
"CanEditClaims": true,
"Identity": "47e61488-fb73-4a9b-bdbc-edd5c9e6fcb5",
"Name": "sample string 6"
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.