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": "de544b37-763f-4103-b4c0-a9a44628087f",
"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": "351b6298-1720-45ac-886a-bde47d00c05b",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "351b6298-1720-45ac-886a-bde47d00c05b",
"Name": "sample string 2"
}
],
"CanEditClaims": true,
"Identity": "7bf02e8b-02f5-487a-8d0b-2141bf1fd4d1",
"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": "b8496777-bca3-49a4-900c-c837f6bf10a2",
"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": "971c73d3-1a65-41c2-9f65-888a389c498c",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "971c73d3-1a65-41c2-9f65-888a389c498c",
"Name": "sample string 2"
}
],
"CanEditClaims": true,
"Identity": "cb073151-1a98-4e0e-b416-2816419379a1",
"Name": "sample string 6"
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.